Module/deepsomatic pr - #389
Open
gbanco4 wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Checklists
Important: When opening a pull request, keep only the applicable checklist and delete all other sections.
Checklist for New Module
Required
I used the cookiecutter template and updated the placeholder rules.
The snakemake rules follow the design guidelines.
rulesobject (e.g. for input files) are wrapped withstr().Every rule in the module is either listed under
localrulesor has thethreadsandresourcesdirectives.Input and output files are being symlinked into the
CFG["inputs"]andCFG["outputs"]subdirectories, respectively.I grouped the input symlinking rule to the next job that uses the input files. Instead of doing this, I have input rules as local rules
I updated the final target rule (
*_all) to include every output rule.I explained important module design decisions in
CHANGELOG.md.I tested the module on real data for all supported
seq_typevalues.I updated the
default.yamlconfiguration file to provide default values for each rule in the module snakefile.I did not set any global wildcard constraints. Any/all wildcard constraints are set on a per-rule basis.
I ensured that all symbolic links are relative and self-contained (i.e. do not point outside of the repository).
I replaced every value that should (or might need to) be updated in the default configuration file with
__UPDATE__.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.