-
Notifications
You must be signed in to change notification settings - Fork 13
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
Amrplusplus #156
Amrplusplus #156
Conversation
config.yaml
Outdated
db: "scripts/amrplusplus/db/megares_modified_database_v2.00.fasta" | ||
annotation: "scripts/amrplusplus/db/megares_modified_annotations_v2.00.csv" | ||
rarefaction: | ||
script: "scripts/amrplusplus/bin/rarefaction" # path to rarefaction script |
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.
We have not utilized this way of referencing script paths in any previous StaG module. I'm not entirely sure that this belongs in the config file, as usage of the script is tightly coupled to the call to the script (in the rule body), so we might as well just hardcode the script path in there... Thoughts?
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.
Sure its easy to change. My main idea with this type of referencing was if we would ever change the structure of scripts
folder we would only need to change the path in config.yaml
and not touch the rulefile itself.
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.
I would like to only have stuff that end-users should be able to modify in the config file. You can still use the params
section to define the path to the script for each rule just like you currently have, just that you hardcode it in place there instead of keeping it here in the config.
We need to add the license text from https://github.com/meglab-metagenomics/amrplusplus_v2 to the subdirectory where we include their scripts (see e.g. how it looks with KrakenTools) |
We also need to write documentation (make a new section in https://github.com/ctmrbio/stag-mwc/blob/amrplusplus/docs/source/modules.rst). We should also make it very clear here that AMRPlusPlus only works with |
Additionally, we need to update the CircleCI tests so the syntax and dag can be automatically validated: https://github.com/ctmrbio/stag-mwc/blob/amrplusplus/.circleci/config.yml |
The CHANGELOG also needs to be updated: https://github.com/ctmrbio/stag-mwc/blob/amrplusplus/CHANGELOG.md#041-unreleased |
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
config.yaml
Outdated
amrplusplus: | ||
databases: | ||
megares_fasta: "scripts/amrplusplus/db/megares_modified_database_v2.00.fasta" | ||
megares_annotation: "scripts/amrplusplus/db/megares_modified_annotations_v2.00.csv" |
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.
How about
amrplusplus: | |
databases: | |
megares_fasta: "scripts/amrplusplus/db/megares_modified_database_v2.00.fasta" | |
megares_annotation: "scripts/amrplusplus/db/megares_modified_annotations_v2.00.csv" | |
amrplusplus: | |
megares: | |
fasta: "scripts/amrplusplus/db/megares_modified_database_v2.00.fasta" | |
annotation: "scripts/amrplusplus/db/megares_modified_annotations_v2.00.csv" |
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com>
This is starting to look good. I would just like to confirm with you @AroArz that you've successfully tried running this with |
|
That was not the button I was looking for.. :). I successfully ran this using |
* Update version to 0.4.1-dev * Update CircleCI badge in README to monitor develop branch * Add Singularity deffile for stag-mwc env * Add Singularity image for main env up to kraken2 * Add link to Singularity bind docs * Add stag-mwc-main singularity image to all rules that require it * Add Singularity images for biobakery and assembly * Set rule threads from cluster_config if defined * Update CHANGELOG * Docs: Update module intro paragraph, closes #151 * Add {cluster.extra} to slurm-submit.py script call * Update CHANGELOG * Fix typo in kraken2 rules * the host removal script was ignoring it's flag in config.yaml * Update CHANGELOG * Update CHANGELOG * Tweak docs, update changelog, prepare for release * Amrplusplus (#156) * amrplusplus * amrplusplus scripts * added scripts * changed input in config.yaml Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * default db empty Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * db -> megares Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * annotation --> megares_annotation Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * added amrplusplus to circleci * updated CHANGELOG.md * updated amrplusplus in config.yaml * added amrplusplus to modules.rst * updated amrplusplus.smk * added license and removed bin dir * updated modules.rst * added align_to_amr * fixed default database * amrplusplus db empty in conf * indentations * clarification regarding database * Update docs/source/modules.rst Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * Update rules/antibiotic_resistance/amrplusplus.smk Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * Update docs/source/modules.rst grammar Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * Update CHANGELOG.md Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * added bwa to stag-mwc.yaml * added conda environment * amrplusplus exectuable with conda * amrplusplus executable with conda * samtools version 1.10 * amrplusplus conda executable * added amrplusplus.yaml to not break stag-mwc.yaml dependencies * removed amrplusplus dependencies because they broke it * now using amrplusplus.yaml for conda instead of stag-mwc.yaml Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> Co-authored-by: Aron Arzoomand <aron@debian.ki.se> * Change report generation call (#161) * Change report generation call Ignore additional arguments to snakemake when creating report, Intended to avoid shell escaping issue with complex arguments to e.g. Singularity, issue #160 * removed snakemake_call * added report generation workaround * report generation Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * report generation Co-authored-by: Fredrik Boulund <boulund@users.noreply.github.com> * indentation Co-authored-by: Aron Arzoomand <51719360+AroArz@users.noreply.github.com> * Slurm profile for CTMR UCP environment (#159) * First draft for CTMR UCP cluster profile * Remove references to rackham profile, remove account check * Updated resource requests for all rules * Final tweaks * Rename ctmr_ucp profile to ctmr_gandalf * Fix yml-yaml typo * Fix incorrectly named singularity images * Remove --use prefix for argument to metawrap * Add missing singularity container to create_kaiju_krona_plot * added dbdir and threads for align_to_amr * Disable area plot for Kaiju * Minor updates to docs (#162) * Update badge URL in README Co-authored-by: Kristaps <kbebris@gmail.com> Co-authored-by: Aron Arzoomand <51719360+AroArz@users.noreply.github.com> Co-authored-by: Aron Arzoomand <aron@debian.ki.se> Co-authored-by: AroArz <aron_arzoomand@live.se>
todo: