[x] All references to the rules object (e.g. for input files) are wrapped with str().
[x] Every rule in the module is either listed under localrules or has the threads and resources directives.
[x] Input and output files are being symlinked into the CFG["inputs"] and CFG["outputs"] subdirectories, respectively.
[x] I grouped the input symlinking rule to the next job that uses the input files.
[x] I updated the final target rule (*_all) to include every output rule.
[x] I explained important module design decisions in CHANGELOG.md.
[x] I tested the module on real data for all supported seq_type values.
[x] I updated the default.yaml configuration file to provide default values for each rule in the module snakefile.
[x] I did not set any global wildcard constraints. Any/all wildcard constraints are set on a per-rule basis.
[x] I ensured that all symbolic links are relative and self-contained (i.e. do not point outside of the repository).
[x] I replaced every value that should (or might need to) be updated in the default configuration file with __UPDATE__.
[x] I recursively searched for all comments containing TODO to ensure none were left. For example:
grep -r TODO modules/<module_name>/1.0
If applicable
[ ] I added more granular output subdirectories.
[ ] I added rules to the reference_files workflow to generate any new reference files.
[ ] I added subdirectories with large intermediate files to the list of scratch_subdirectories in the default.yaml configuration file.
[ ] I updated the list of available wildcards for the input files in the default.yaml configuration file.
Checklist for Updated Module
Important! If you are updating the module version, ensure the previous version of the module is restored from master.
If you want to restore a deleted file or directory from the remote master, you can use git checkout origin/master path/to/file,
then a git commit will ensure that file is tracked on your branch again.
Example:
Pull Request Checklists
Created an lcr-module for spechla, which performs hla-typing at a rapid speed for mRNA, WES, and WGS (and long reads).
https://pubmed.ncbi.nlm.nih.gov/37714157/
Does not seem particularly useful for FFPE tissue.
Important: When opening a pull request, keep only the applicable checklist and delete all other sections.
Checklist for New Module
Required
[x] I used the cookiecutter template and updated the placeholder rules.
[x] The snakemake rules follow the design guidelines.
rulesobject (e.g. for input files) are wrapped withstr().[x] Every rule in the module is either listed under
localrulesor has thethreadsandresourcesdirectives.[x] Input and output files are being symlinked into the
CFG["inputs"]andCFG["outputs"]subdirectories, respectively.[x] I grouped the input symlinking rule to the next job that uses the input files.
[x] I updated the final target rule (
*_all) to include every output rule.[x] I explained important module design decisions in
CHANGELOG.md.[x] I tested the module on real data for all supported
seq_typevalues.[x] I updated the
default.yamlconfiguration file to provide default values for each rule in the module snakefile.[x] I did not set any global wildcard constraints. Any/all wildcard constraints are set on a per-rule basis.
[x] I ensured that all symbolic links are relative and self-contained (i.e. do not point outside of the repository).
[x] I replaced every value that should (or might need to) be updated in the default configuration file with
__UPDATE__.[x] I recursively searched for all comments containing
TODOto ensure none were left. For example:If applicable
[ ] I added more granular output subdirectories.
[ ] I added rules to the
reference_filesworkflow to generate any new reference files.[ ] I added subdirectories with large intermediate files to the list of
scratch_subdirectoriesin thedefault.yamlconfiguration file.[ ] I updated the list of available wildcards for the input files in the
default.yamlconfiguration file.Checklist for Updated Module
Important! If you are updating the module version, ensure the previous version of the module is restored from master. If you want to restore a deleted file or directory from the remote master, you can use
git checkout origin/master path/to/file, then agit commitwill ensure that file is tracked on your branch again. Example: