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

feat: Add wrapper for GATK DepthOfCoverage #494

Conversation

ljmesi
Copy link
Contributor

@ljmesi ljmesi commented Jun 8, 2022

Description

This PR adds a wrapper for GATK DepthOfCoverage tool.

QC

For all wrappers added by this PR, I made sure that

  • there is a test case which covers any introduced changes,
  • input: and output: file paths in the resulting rule can be changed arbitrarily,
  • either the wrapper can only use a single core, or the example rule contains a threads: x statement with x being a reasonable default,
  • rule names in the test case are in snake_case and somehow tell what the rule is about or match the tools purpose or name (e.g., map_reads for a step that maps reads),
  • all environment.yaml specifications follow the respective best practices,
  • wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in input: or output:),
  • all fields of the example rules in the Snakefiles and their entries are explained via comments (input:/output:/params: etc.),
  • stderr and/or stdout are logged correctly (log:), depending on the wrapped tool,
  • temporary files are either written to a unique hidden folder in the working directory, or (better) stored where the Python function tempfile.gettempdir() points to (see here; this also means that using any Python tempfile default behavior works),
  • the meta.yaml contains a link to the documentation of the respective tool or command,
  • Snakefiles pass the linting (snakemake --lint),
  • Snakefiles are formatted with snakefmt,
  • Python wrapper scripts are formatted with black.

@ljmesi ljmesi closed this Jun 9, 2022
@ljmesi ljmesi reopened this Jun 9, 2022
@ljmesi ljmesi closed this Jun 9, 2022
@ljmesi ljmesi reopened this Jun 9, 2022
@ljmesi ljmesi requested a review from fgvieira June 13, 2022 14:48
bio/gatk/depthofcoverage/test/Snakefile Outdated Show resolved Hide resolved
bio/gatk/depthofcoverage/meta.yaml Outdated Show resolved Hide resolved
test.py Outdated Show resolved Hide resolved
ljmesi and others added 2 commits August 17, 2022 09:35
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
@ljmesi
Copy link
Contributor Author

ljmesi commented Sep 7, 2022

@johanneskoester Should there be done anything additional so that this PR can be merged?

@johanneskoester johanneskoester merged commit 636060a into snakemake:master Sep 19, 2022
@johanneskoester
Copy link
Contributor

Thanks a lot!

@ljmesi ljmesi deleted the gatk-depth-of-coverage branch September 23, 2022 07:08
Phlya pushed a commit to Phlya/snakemake-wrappers that referenced this pull request Jan 10, 2023
* feat: add depthofcoverage wrapper

* test: add test and test data for depthofcoverage

* docs: add comments describing some of the input and output fields

* docs: add link to the tool documentation

* docs: add comment

* feat: add wildcards for sample names

* fix: update bio/gatk/depthofcoverage/meta.yaml

Co-authored-by: Filipe G. Vieira <fgarrettvieira@gmail.com>

* fix: add missing wildcard expression

* feat: remove multi-sample processing

* feat: name all generated output files explicitly

* fix: remove "--use-conda"

Co-authored-by: Patrik Smeds <patrik.smeds@gmail.com>

* refactor: simplify getting output file basename

* fix: update channel priority order

Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>

Co-authored-by: Filipe G. Vieira <fgarrettvieira@gmail.com>
Co-authored-by: Patrik Smeds <patrik.smeds@gmail.com>
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants