nf-core / nf-core/modules

[FEATURE] Support generating a pooled reference in cnvkit/reference

Open
#12,656 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nextflow
Stars
429
Forks
1.1k
Avg merge
1d 6h
Merged PRs (30d)
153

Description

Is your feature request related to a problem? Please describe

Currently the cnvkit/reference module only seems to support generating a flat reference as you cannot provide coverage files to generate a pooled normal reference e.g

cnvkit.py reference normal1_coverage.cnn normal2coverage.cnn ... -f hg38.fa -o reference.cnn
Describe the solution you'd like

The module should be extended by adding an input for the normal-sample coverage .cnn files and passing those files positionally to cnvkit.py reference. That is the mechanism CNVkit itself uses to distinguish a pooled reference from a flat reference. The current module only supplies --fasta, --targets, and --antitargets, so CNVkit has no normal coverage profiles to pool and therefore builds a flat reference.

Describe alternatives you've considered

No response

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the module entry point that wraps cnvkit.py reference and inspect how its current --fasta, --targets, and --antitargets arguments are assembled. Add support for positional normal-sample .cnn inputs, then verify the generated command pools those files while retaining flat-reference behavior when none are supplied.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.