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 modularization.rst #2137

Merged
merged 2 commits into from Feb 28, 2023
Merged

docs: Update modularization.rst #2137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27d048f
Update modularization.rst
SultanOrazbayev Feb 23, 2023
aa50910
Update modularization.rst
SultanOrazbayev Feb 23, 2023
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
4 changes: 4 additions & 0 deletions docs/snakefiles/modularization.rst
View file
Open in desktop
Expand Up @@ -138,6 +138,10 @@ The second statement, ``use rule * from other_workflow exclude ruleC as other_*`
Thereby, the ``as other_*`` at the end renames all those rules with a common prefix.
This can be handy to avoid rule name conflicts (note that rules from modules can otherwise overwrite rules from your current workflow or other modules).

.. note::

The imported module cannot be named as `workflow`, which is a reserved name.

The module is evaluated in a separate namespace, and only the selected rules are added to the current workflow.
Non-rule Python statements inside the module are also evaluated in that separate namespace.
They are available in the module-defining workflow under the name of the module (e.g. here ``other_workflow.myfunction()`` would call the function ``myfunction`` that has been defined in the model, e.g. in ``other_workflow/Snakefile``).
Expand Down