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: bwa-meme picard option #558

Merged
merged 26 commits into from Oct 10, 2022
Merged

feat: bwa-meme picard option #558

merged 26 commits into from Oct 10, 2022

Conversation

christopher-schroeder
Copy link
Contributor

Description

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).

@christopher-schroeder christopher-schroeder changed the title typo in rule naming, reactivate picard option, picard test feat: bwa-meme picard option Sep 20, 2022
@johanneskoester johanneskoester merged commit 76174cf into master Oct 10, 2022
@johanneskoester johanneskoester deleted the bwa-meme_features branch October 10, 2022 17:00
Phlya pushed a commit to Phlya/snakemake-wrappers that referenced this pull request Jan 10, 2023
* typo in rule naming, reactivate picard option, picard test

* wrongly configured test

* wrongly configured test again

* genome wildcard is now hardcoded in test

* wrapper path

* dont use other wrappers in test

* dont use other wrappers in test

* environment.yaml in test

* try again wrapper in test

* try index wrapper again

* use all rule

* version index wrapper

* remove index env

* used_wrappers.yaml

* used_wrappers.yaml

* swap for github action

* swap 10g

* swap 20g

* number of model parameters in index to decrease resource consumption for test

* revert swap size

* different approach, zipped file now

* snakefmt, black

* log for extraction

* conda for gzip to satisfy linter

* add the yaml

* mbuffer to 2g
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