Skip to content

Commit

Permalink
add information about min rust-script version + conda env yaml (#1175)
Browse files Browse the repository at this point in the history
Co-authored-by: Johannes Köster <johannes.koester@uni-due.de>
  • Loading branch information
tedil and johanneskoester committed Sep 24, 2021
1 parent 5dc6bbd commit 51e5afc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/snakefiles/rules.rst
Expand Up @@ -736,6 +736,8 @@ Rust_
"path/to/another/outputfile"
params:
seed=4
conda:
"rust.yaml"
log:
stdout="path/to/stdout.log",
stderr="path/to/stderr.log",
Expand All @@ -745,6 +747,17 @@ Rust_
The ability to execute Rust scripts is facilitated by |rust-script|_. As such, the
script must be a valid ``rust-script`` script and ``rust-script`` must be available in the
environment the rule is run in.
The minimum required ``rust-script`` version is `1.15.0`, so in the example above, the contents of ``rust.yaml`` might look like this:

.. code block:: yaml
channels:
- conda-forge
- bioconda
dependencies:
- rust-script>=0.15.0
Some example scripts can be found in the
`tests directory <https://github.com/snakemake/snakemake/tree/main/tests/test_script/scripts>`_.
Expand Down

0 comments on commit 51e5afc

Please sign in to comment.