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.

Sign up for GitHub

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

Jump to bottom

chore: Add information about min rust-script version + conda env yaml #1175

Merged
merged 2 commits into from
Sep 24, 2021
Merged

chore: Add information about min rust-script version + conda env yaml #1175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1eebb43
add information about min rust-script version + conda env yaml
tedil Sep 14, 2021
31ab638
Merge branch 'main' into update-rust-script-doc
johanneskoester Sep 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/snakefiles/rules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
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