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.

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

Phylogenetics tools! #249

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Phylogenetics tools! #249

wants to merge 17 commits into from

Conversation

lkhilton
Copy link
Member

Pull Request Checklists

Checklist for New Module

Required

  • I used the cookiecutter template and updated the placeholder rules.

  • The snakemake rules follow the design guidelines.

    • All references to the rules object (e.g. for input files) are wrapped with str().
  • Every rule in the module is either listed under localrules or has the threads and resources directives.

  • Input and output files are being symlinked into the CFG["inputs"] and CFG["outputs"] subdirectories, respectively.

  • I grouped the input symlinking rule to the next job that uses the input files.

  • 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_type values.

  • I updated the default.yaml configuration 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 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.

@lkhilton lkhilton requested a review from ckrushton September 13, 2022 05:54
Copy link
Collaborator

@Kdreval Kdreval left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Important update!

envs/phylowgs/fill_battenberg.yaml Outdated Show resolved Hide resolved
modules/phylowgs/1.0/etc/noncoding.txt Show resolved Hide resolved
modules/phylowgs/1.0/phylowgs.smk Show resolved Hide resolved
modules/phylowgs/1.0/etc/noncoding.txt Show resolved Hide resolved
modules/phylowgs/1.0/phylowgs.smk Show resolved Hide resolved
modules/pyclone_vi/1.0/config/default.yaml Outdated Show resolved Hide resolved
modules/pyclone_vi/1.0/envs/gamblr.yaml Show resolved Hide resolved
modules/pyclone_vi/1.0/pyclone_vi.smk Outdated Show resolved Hide resolved
modules/pyclone_vi/1.0/pyclone_vi.smk Outdated Show resolved Hide resolved
modules/pyclone_vi/1.0/pyclone_vi.smk Outdated Show resolved Hide resolved
@Kdreval
Copy link
Collaborator

Kdreval commented Jul 26, 2024

@lkhilton this is merge-able?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants