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: wrapper for Manta SV caller #415

Merged
merged 28 commits into from Jan 26, 2022
Merged

Conversation

fgvieira
Copy link
Collaborator

@fgvieira fgvieira commented Nov 4, 2021

Description

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.

@fgvieira
Copy link
Collaborator Author

fgvieira commented Nov 4, 2021

Not sure how to deal with the temp files, since manta creates a folder with everything (temp files included).
We could set the workdir to a temp folder (with python tempfile), but this would make it impossible to access all the logs and intermediate files manta creates (in case the user wants them).

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 work, just one thing.

bio/manta/test/Snakefile Outdated Show resolved Hide resolved
bio/manta/wrapper.py Outdated Show resolved Hide resolved
@fgvieira fgvieira changed the title Wrapper for Manta SV caller feat: wrapper for Manta SV caller Jan 17, 2022
bio/manta/wrapper.py Outdated Show resolved Hide resolved
@johanneskoester johanneskoester merged commit 6b4d6a1 into snakemake:master Jan 26, 2022
@fgvieira fgvieira deleted the manta branch January 26, 2022 14:45
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