-
Notifications
You must be signed in to change notification settings - Fork 12
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
A tiny change: use a phylogenetic directory #15
Conversation
Move phylogenetic workflow from top-level to folder phylogenetic in order to follow the Pathogen Repo Template: https://github.com/nextstrain/pathogen-repo-template
2785912
to
c9764b7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The majority of the changes look good to me 👍
My only request to is update the CI workflow since it currently does not fully work as intended. Looking at the latest CI job on this branch, there are no artifacts uploaded due to the bug so we cannot inspect the build outputs.
Reduce confusion of the use of the profiles' config files. They are to be seen as additional profiles' config on top of the default configs. Stems from discussion with @j23414 for review of nextstrain/dengue#15. Note we not using `config.yaml` because this is used by the Snakemake profiles configuration.¹ ¹ https://snakemake.readthedocs.io/en/stable/executing/cli.html#profiles
Hi @joverlee521! This PR is ready for review. Following our earlier discussion, I've implemented further changes, but am open to further revisions.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working through this! I caught a couple smaller things but should be good to merge!
[auspice]: https://docs.nextstrain.org/projects/auspice/en/stable/index.html | ||
[Installing Nextstrain guide]: https://docs.nextstrain.org/en/latest/install.html | ||
[Running a Pathogen Workflow guide]: https://docs.nextstrain.org/en/latest/tutorials/running-a-workflow.html | ||
- [Contributor documentation](./CONTRIBUTING.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just realizing this CONTRIBUTING.md
file also does not exist in this repo.
phylogenetic/README.md
Outdated
Alternatively, you can run the build using the | ||
example data provided in this repository. Before running the build, copy the | ||
example sequences into the `data/` directory like so: | ||
|
||
mkdir -p data/ | ||
cp example_data/dengue* data/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One other benefit to having the CI profile is users no longer have to manually copy over the example data.
These instructions can be updated to use
nextstrain build . --configfile profiles/ci/profiles_config.yaml
Part of work to update this repo to match the pathogen-repo-template.
Part of work to update this repo to match the pathogen-repo-template.
Part of work to update this repo to match the pathogen-repo-template.
Part of work to update this repo to match the pathogen-repo-template.
Use the stopgap from mpox (nextstrain/mpox#214) until the pathogen-repo-ci is updated.
One benefit to having the CI profile is users no longer have to manually copy over the example data.
904c904
to
adf16b8
Compare
Reduce confusion of the use of the customizations' config files. They are to be seen as additional custom configs on top of the default configs. Stems from discussion with @j23414 for review of nextstrain/dengue#15.
Reduce confusion of the use of the customizations' config files. They are to be seen as additional custom configs on top of the default configs. Stems from discussion with @j23414 for review of nextstrain/dengue#15.
Description of proposed changes
A tiny change ;) Use a phylogenetic directory to follow the pathogen-repo-template.
Related issue(s)
Checklist