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

docs: Update workflow syntax with priority directive #2188

Merged
merged 1 commit into from
Apr 28, 2023
Merged

docs: Update workflow syntax with priority directive #2188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docs/snakefiles/writing_snakefiles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Thereby wildcards can be used to write general rules.
Grammar
-------

The Snakefile syntax obeys the following grammar, given in extended Backus-Naur form (EBNF)
The Snakefile syntax obeys the following grammar, given in `extended Backus-Naur form (EBNF) <https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form>`_.

.. code-block:: text

Expand All @@ -27,7 +27,7 @@ The Snakefile syntax obeys the following grammar, given in extended Backus-Naur
configfile = "configfile" ":" stringliteral
userule = "use" "rule" (identifier | "*") "from" identifier ["as" identifier] ["with" ":" norunparams]
ni = NEWLINE INDENT
norunparams = [ni input] [ni output] [ni params] [ni message] [ni threads] [ni resources] [ni log] [ni conda] [ni container] [ni benchmark] [ni cache]
norunparams = [ni input] [ni output] [ni params] [ni message] [ni threads] [ni resources] [ni log] [ni conda] [ni container] [ni benchmark] [ni cache] [ni priority]
ruleparams = norunparams [ni (run | shell | script | notebook)] NEWLINE snakemake
input = "input" ":" parameter_list
output = "output" ":" parameter_list
Expand All @@ -37,6 +37,7 @@ The Snakefile syntax obeys the following grammar, given in extended Backus-Naur
cache = "cache" ":" bool
message = "message" ":" stringliteral
threads = "threads" ":" integer
priority = "priority" ":" integer
resources = "resources" ":" parameter_list
version = "version" ":" statement
conda = "conda" ":" stringliteral
Expand Down Expand Up @@ -67,4 +68,4 @@ From Snakemake 3.2 on, if your workflow depends on a minimum Snakemake version,

min_version("3.2")

given that your minimum required version of Snakemake is 3.2. The statement will raise a WorkflowError (and therefore abort the workflow execution) if the version is not met.
given that your minimum required version of Snakemake is 3.2. The statement will raise a WorkflowError (and therefore abort the workflow execution) if the version is not met.