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: remove existing run directory option for strelka #1297

Merged
merged 17 commits into from Jun 12, 2023
Merged

Conversation

christopher-schroeder
Copy link
Contributor

Description

When strelka reruns it doesn't like if the run directory exists. Add an option to delete it before.

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 remove existing run directory option feat: remove existing run directory option for strelka Apr 27, 2023
@fgvieira
Copy link
Collaborator

Wouldn't it be better to output to a temp folder and then copy relevant results to their final destination?
For example, like it was done for STAR.

@christopher-schroeder
Copy link
Contributor Author

Wouldn't it be better to output to a temp folder and then copy relevant results to their final destination? For example, like it was done for STAR.

Yes, ok - why not.

bio/strelka/germline/wrapper.py Outdated Show resolved Hide resolved
@@ -7,13 +7,13 @@ rule strelka_germline:
fasta_index="genome.fasta.fai"
output:
# Strelka results - either use directory or complete file path
directory("strelka/{sample}")
variants="strelka/{sample}.vcf.gz"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please add the other possibilities (indices etc.) so that the people have a comprehensive example of what can be given here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, the wrapper is not done yet

Copy link
Contributor

Choose a reason for hiding this comment

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

I unresolved this just so that I don't forget the request until it is done.

@johanneskoester johanneskoester merged commit 6f384dd into master Jun 12, 2023
6 checks passed
@johanneskoester johanneskoester deleted the strelka branch June 12, 2023 10:25
johanneskoester pushed a commit that referenced this pull request Jun 13, 2023
🤖 I have created a release \*beep\* \*boop\*
---
##
[2.0.0](https://www.github.com/snakemake/snakemake-wrappers/compare/v1.32.1...v2.0.0)
(2023-06-13)


### ⚠ BREAKING CHANGES

* replace individual seqkit wrappers with a single wrapper for all
seqkit commands (#1426)

### Features

* remove existing run directory option for strelka
([#1297](https://www.github.com/snakemake/snakemake-wrappers/issues/1297))
([6f384dd](https://www.github.com/snakemake/snakemake-wrappers/commit/6f384ddc857293ec799526b75d355f5015191f70))
* replace individual seqkit wrappers with a single wrapper for all
seqkit commands
([#1426](https://www.github.com/snakemake/snakemake-wrappers/issues/1426))
([c7a4d96](https://www.github.com/snakemake/snakemake-wrappers/commit/c7a4d960044888825f2b9475d4df7b8f09cec0a0))
---


This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@christopher-schroeder christopher-schroeder restored the strelka branch June 28, 2023 09:05
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

3 participants