Skip to content

Commit

Permalink
Notes on subworkflow limitations and their deprecation.
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskoester committed Mar 15, 2022
1 parent 84ff2b5 commit 37f8c11
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/snakefiles/modularization.rst
Expand Up @@ -235,7 +235,8 @@ And finally, we overwrite the input directive of the rule ``bwa_mem`` such that
Sub-Workflows
-------------

In addition to including rules of another workflow, Snakemake allows to depend on the output of other workflows as sub-workflows.
Snakemake allows to depend on the output of other workflows as sub-workflows.
However, note that sub-workflows are deprecated in favor of :ref:`modules <snakefiles-modules>`.
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.
Expand Down Expand Up @@ -268,6 +269,8 @@ When executing, snakemake first tries to create (or update, if necessary) ``test
Then the current workflow is executed.
This can also happen recursively, since the subworkflow may have its own subworkflows as well.

Note that subworkflow rules will not be displayed in a :ref:`Snakemake report <snakefiles-reports>` generated from the surrounding workflow.


.. _snakefile-code-hosting-providers:

Expand Down

0 comments on commit 37f8c11

Please sign in to comment.