Skip to content

Conversation

@Austin-s-h
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).

@mergify
Copy link

mergify bot commented Apr 17, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

9 similar comments
@mergify
Copy link

mergify bot commented May 16, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented May 25, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jun 9, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jun 16, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jun 26, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jul 6, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jul 14, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Jul 27, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@mergify
Copy link

mergify bot commented Aug 4, 2023

⚠️ The sha of the head commit of this PR conflicts with #1172. Mergify cannot evaluate rules on this PR. ⚠️

@Austin-s-h Austin-s-h closed this Aug 4, 2023
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.

1 participant