use snakemake.params
to auto re-run due to config changes
#296
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes # (if applicable).
Changes proposed in this Pull Request
Use the
params:
section in rule definition to keep track of changed settings inconfig.yaml
.https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules
The goal is that rules for which parameters have changed rerun automatically.
This can currently be done with:
https://snakemake.readthedocs.io/en/stable/project_info/faq.html#how-do-i-trigger-re-runs-for-rules-with-updated-code-or-parameters
snakemake -n -R `snakemake --list-params-changes`
or
snakemake -R $(snakemake --list-params-changes)
This will be even more convenient, once this
snakemake
PR is released:snakemake/snakemake#1107
or
(which would also include code changes)
It seems to work very nicely to pass lists/dicts as params, which would help us keep config "blocks".
This PR is not complete yet, but a proof-of-concept for a selection of config settings. We can discuss from here and complete later.
Checklist
envs/environment.yaml
andenvs/environment.docs.yaml
.config.default.yaml
,config.tutorial.yaml
, andtest/config.test1.yaml
.doc/configtables/*.csv
and line references are adjusted indoc/configuration.rst
anddoc/tutorial.rst
.doc/release_notes.rst
is amended in the format of previous release notes.