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: added wrapper-utils, and tempdirs #467

Merged
merged 11 commits into from Aug 16, 2022

Conversation

fgvieira
Copy link
Collaborator

Description

Added snakemake-wrapper-utils and temp dirs (with tempfile).
Also updated some docs.

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 fgvieira changed the title Added wrapper-utils, and tempdirs feat: added wrapper-utils, and tempdirs Mar 20, 2022
@fgvieira fgvieira marked this pull request as draft March 20, 2022 00:59
@johanneskoester
Copy link
Contributor

Hey @fgvieira any chance to get this ready for merging? If we wait too long with this, conflicts will accumulate as it touches many wrappers.

@fgvieira
Copy link
Collaborator Author

I'm waiting on a PR on snakemake-wrapper-utils (snakemake/snakemake-wrapper-utils#13)

@fgvieira fgvieira force-pushed the bcftools_tmp branch 3 times, most recently from 3f4da8c to f40ad13 Compare April 28, 2022 12:24
@fgvieira
Copy link
Collaborator Author

There was a bug on snakemake-wrapper-utils; waiting now on snakemake/snakemake-wrapper-utils#15

@fgvieira fgvieira marked this pull request as ready for review July 1, 2022 07:30
@fgvieira fgvieira merged commit 48c49a9 into snakemake:master Aug 16, 2022
@fgvieira fgvieira deleted the bcftools_tmp branch August 16, 2022 12:37
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