Modularization in Snakemake comes at different levels.
- The most fine-grained level are wrappers. They are available and can be published at the Snakemake Wrapper Repository. These wrappers can then be composed and customized according to your needs, by copying skeleton rules into your workflow. In combination with conda integration, wrappers also automatically deploy the needed software dependencies into isolated environments.
- For larger, reusable parts that shall be integrated into a common workflow, it is recommended to write small Snakefiles and include them into a master Snakefile via the include statement. In such a setup, all rules share a common config file.
- The third level of separation are subworkflows. Importantly, these are rather meant as links between otherwise separate data analyses.
The wrapper directive allows to have re-usable wrapper scripts around e.g. command line tools.
In contrast to modularization strategies like
include or subworkflows, the wrapper directive allows to re-wire the DAG of jobs.
Refers to the wrapper
"0.0.8/bio/samtools_sort" to create the output from the input.
Snakemake will automatically download the wrapper from the Snakemake Wrapper Repository.
Thereby, 0.0.8 can be replaced with the git version tag you want to use, or a commit id (see here).
This ensures reproducibility since changes in the wrapper implementation won’t be propagated automatically to your workflow.
Alternatively, e.g., for development, the wrapper directive can also point to full URLs, including URLs to local files with absolute paths
file:// or relative paths
Examples for each wrapper can be found in the READMEs located in the wrapper subdirectories at the Snakemake Wrapper Repository.
The Snakemake Wrapper Repository is meant as a collaborative project and pull requests are very welcome.
Another Snakefile with all its rules can be included into the current:
The default target rule (often called the
all-rule), won’t be affected by the include.
I.e. it will always be the first rule in your Snakefile, no matter how many includes you have above your first rule.
Includes are relative to the directory of the Snakefile in which they occur.
For example, if above Snakefile resides in the directory
my/dir, then Snakemake will search for the include at
my/dir/path/to/other/snakefile, regardless of the working directory.
In addition to including rules of another workflow, Snakemake allows to depend on the output of other workflows as sub-workflows. A sub-workflow is executed independently before the current workflow is executed. Thereby, Snakemake ensures that all files the current workflow depends on are created or updated if necessary. This allows to create links between otherwise separate data analyses.
Here, the subworkflow is named “otherworkflow” and it is located in the working directory
The snakefile is in the same directory and called
snakefile is not defined for the subworkflow, it is assumed be located in the workdir location and called
Snakefile, hence, above we could have left the
snakefile keyword out as well.
workdir is not specified, it is assumed to be the same as the current one.
Files that are output from the subworkflow that we depend on are marked with the
otherworkflow function (see the input of rule a).
This function automatically determines the absolute path to the file (here
When executing, snakemake first tries to create (or update, if necessary)
test.txt (and all other possibly mentioned dependencies) by executing the subworkflow.
Then the current workflow is executed.
This can also happen recursively, since the subworkflow may have its own subworkflows as well.