Skip to content

Commit

Permalink
feat: Update datavzrd to 2.18.4 and add extra params (#1292)
Browse files Browse the repository at this point in the history
<!-- Ensure that the PR title follows conventional commit style (<type>:
<description>)-->
<!-- Possible types are here:
https://github.com/commitizen/conventional-commit-types/blob/master/index.json
-->

### Description

Update datavzrd and allow optional arguments via `extra`-param

### QC
<!-- Make sure that you can tick the boxes below. -->

* [x] 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](https://en.wikipedia.org/wiki/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](https://stackoverflow.com/a/64594513/2352071),
* 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 `Snakefile`s 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](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir);
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,
* `Snakefile`s pass the linting (`snakemake --lint`),
* `Snakefile`s are formatted with
[snakefmt](https://github.com/snakemake/snakefmt),
* Python wrapper scripts are formatted with
[black](https://black.readthedocs.io).
* 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).

---------

Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
  • Loading branch information
FelixMoelder and johanneskoester committed Apr 26, 2023
1 parent 73ed8cb commit fa11c1c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion utils/datavzrd/environment.yaml
Expand Up @@ -2,4 +2,4 @@ channels:
- conda-forge
- nodefaults
dependencies:
- datavzrd =2.18.1
- datavzrd =2.18.4
2 changes: 2 additions & 0 deletions utils/datavzrd/test/Snakefile
Expand Up @@ -8,6 +8,8 @@ rule datavzrd:
config="resources/{sample}.datavzrd.yaml",
# optional files required for rendering the given config
table="data/A.tsv",
params:
extra="",
output:
report(
directory("results/datavzrd-report/{sample}"),
Expand Down
4 changes: 3 additions & 1 deletion utils/datavzrd/wrapper.py
Expand Up @@ -7,4 +7,6 @@

log = snakemake.log_fmt_shell(stdout=True, stderr=True)

shell("datavzrd {snakemake.input.config} --output {snakemake.output[0]} {log}")
extra = snakemake.params.get("extra", "")

shell("datavzrd {snakemake.input.config} {extra} --output {snakemake.output[0]} {log}")

0 comments on commit fa11c1c

Please sign in to comment.