Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add nextstrain-automation build-configs to phylogenetic workflow #21

Merged
merged 4 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# CHANGELOG
* 2 April 2024: Add nextstrain-automation build-configs for deploying the final Auspice dataset of the phylogenetic workflow
* 1 April 2024: Create a tree using the 450 nucleotides encoding the carboxyl-terminal 150 amino acids of the nucleoprotein (N450), which is highly represented on NCBI for measles. [PR #20](https://github.com/nextstrain/measles/pull/20)
* 15 March 2024: Connect ingest and phylogenetic workflows to follow the pathogen-repo-guide by uploading ingest output to S3, downloading ingest output from S3 to phylogenetic directory, using "accession" column as the ID column, and using a color scheme that matches the new region name format. [PR #19](https://github.com/nextstrain/measles/pull/19)
* 1 March 2024: Add phylogenetic directory to follow the pathogen-repo-guide, and update the CI workflow to match the new file structure. [PR #18](https://github.com/nextstrain/measles/pull/18)
Expand Down
24 changes: 19 additions & 5 deletions phylogenetic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Once you've run the build, you can view the results with:

## Configuration

Configuration takes place entirely with the `Snakefile`. This can be read
top-to-bottom, each rule specifies its file inputs and output and also its
parameters. There is little redirection and each rule should be able to be
reasoned with on its own.
Configuration for the workflow takes place entirely within the [defaults/config.yaml](defaults/config.yaml).
The analysis pipeline is contained in [Snakefile](Snakefile) with included [rules](rules).
Each rule specifies its file inputs and output and pulls its parameters from the config.
There is little redirection and each rule should be able to be reasoned with on its own.

### Using GenBank data

Expand All @@ -47,4 +47,18 @@ Alternatively, you can run the build using the
example data provided in this repository. To run the build by copying the
example sequences into the `data/` directory, use the following:

nextstrain build . --configfile profiles/ci/profiles_config.yaml
nextstrain build . --configfile build-configs/ci/config.yaml

### Deploying build

To run the workflow and automatically deploy the build to nextstrain.org,
you will need to have AWS credentials to run the following:

```
nextstrain build \
--env AWS_ACCESS_KEY_ID \
--env AWS_SECRET_ACCESS_KEY \
. \
deploy_all \
--configfile build-configs/nextstrain-automation/config.yaml
```
4 changes: 4 additions & 0 deletions phylogenetic/build-configs/nextstrain-automation/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
custom_rules:
- build-configs/nextstrain-automation/deploy.smk

deploy_url: "s3://nextstrain-data"
15 changes: 15 additions & 0 deletions phylogenetic/build-configs/nextstrain-automation/deploy.smk
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
This part of the workflow handles automatic deployments of the measles build.
Uploads the build defined as the default output of the workflow through
the `all` rule from Snakefille
"""

rule deploy_all:
input: *rules.all.input
output: touch("results/deploy_all.done")
params:
deploy_url = config["deploy_url"]
shell:
"""
nextstrain remote upload {params.deploy_url} {input}
"""