-
Notifications
You must be signed in to change notification settings - Fork 188
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
Added wrapper for verifybamid2. #401
Conversation
# optional - this can be used to specify custom resource files if | ||
# necessary (if using GRCh37 or GRCh38 instead simply specify | ||
# genome_build="38", for example | ||
svd_prefix="ref.vcf", |
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.
This should be an optional input file then, not a parameter.
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.
So the svd_prefix
that is passed in to verifybamid2
is not actually a file that exists, so that's why I didn't make it an input file. I could change it to have as an input one of the files that do exist, strip off the file suffix, and pass that to verifybamid2
if you would prefer.
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.
Mhm, would it be possible to specify all needed files under that prefix explicitly? E.g. using multiext?
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 changed params.svd_prefix
to input.svd_mu
. This file name would be the same as the other with the suffix .mu
appended. verifybamid2
requires other files with suffixes .bed
, .UD
, and .V
to exist so the wrapper checks that.
Please note that the wrapper looks explicitly for input.svd_mu
and not for the others as far as specified arguments go. I just thought that approach would be simpler to work with.
Thanks a lot, nice work! Just one comment above. |
e0215fd
to
102751a
Compare
…e of other necessary resource files.
Description
This provides a wrapper for the tool
verifybamid2
which can be used to estimate intra-species contamination in a BAM file.QC
For all wrappers added by this PR, I made sure that
input:
andoutput:
file paths in the resulting rule can be changed arbitrarily,map_reads
for a step that maps reads),environment.yaml
specifications follow the respective best practices,input:
oroutput:
),Snakefile
s and their entries are explained via comments (input:
/output:
/params:
etc.),stderr
and/orstdout
are logged correctly (log:
), depending on the wrapped tool,tempfile.gettempdir()
points to (see here; this also means that using any Pythontempfile
default behavior works),meta.yaml
contains a link to the documentation of the respective tool or command,Snakefile
s pass the linting (snakemake --lint
),Snakefile
s are formatted with snakefmt,