snakemake-wrappers icon indicating copy to clipboard operation
snakemake-wrappers copied to clipboard

Add GATK ValidateVariants

Open G-kodes opened this issue 4 years ago • 2 comments

Description

An implementation of the GATK ValidateVariants tool

QC

For all wrappers added by this PR, I made sure that

  • [x] there is a test case which covers any introduced changes,
  • [x] input: and output: file paths in the resulting rule can be changed arbitrarily,
  • [x] 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),
  • [x] all environment.yaml specifications follow the respective best practices,
  • [x] wherever possible, command line arguments are inferred and set automatically (e.g. based on file extensions in input: or output:),
  • [x] all fields of the example rules in the Snakefiles and their entries are explained via comments (input:/output:/params: etc.),
  • [x] stderr and/or stdout are logged correctly (log:), depending on the wrapped tool,
  • [x] 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),
  • [x] the meta.yaml contains a link to the documentation of the respective tool or command,
  • [x] Snakefiles pass the linting (snakemake --lint),
  • [x] Snakefiles are formatted with snakefmt,
  • [x] Python wrapper scripts are formatted with black.

Lord have mercy on my code. PR's are stressful lol

G-kodes avatar Jul 19 '21 21:07 G-kodes

Maybe it would also be nice to set tmpdir with tempfile.

fgvieira avatar Feb 08 '22 09:02 fgvieira

This PR was marked as stale because it has been open for 6 months with no activity.

github-actions[bot] avatar Feb 01 '24 01:02 github-actions[bot]