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 bwa-meme #555

Merged
merged 5 commits into from Sep 17, 2022
Merged

feat: Add wrapper for bwa-meme #555

merged 5 commits into from Sep 17, 2022

Conversation

christopher-schroeder
Copy link
Contributor

Description

Add a wrapper for bwa-meme, which provides a machine learning method to improve the index, which increases the performance by a factor of 1.4 compared to bwa-mem 2.

QC

  • I confirm that:

For all wrappers added by this PR,

  • 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.
  • Conda environments use a minimal amount of channels, in recommended ordering. E.g. for bioconda, use (conda-forge, bioconda, nodefaults, as conda-forge should have highest priority and defaults channels are usually not needed because most packages are in conda-forge nowadays).

Copy link
Contributor

@johanneskoester johanneskoester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Just some very few suggestions.

bio/bwa-meme/index/test/Snakefile Outdated Show resolved Hide resolved
bio/bwa-meme/mem/test/Snakefile_samtools Outdated Show resolved Hide resolved
bio/bwa-meme/mem/test/Snakefile_samtools Outdated Show resolved Hide resolved
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
@johanneskoester johanneskoester merged commit 92579c4 into master Sep 17, 2022
@johanneskoester johanneskoester deleted the bwa-meme branch September 17, 2022 19:28
Phlya pushed a commit to Phlya/snakemake-wrappers that referenced this pull request Jan 10, 2023
* bwa-meme initial commit

* wrapper path

* Update bio/bwa-meme/index/test/Snakefile

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

* Update bio/bwa-meme/mem/test/Snakefile_samtools

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

* samtools test to normal test

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

2 participants