nf-core / nf-core/modules

update cnvkit/batch output channels

Open
#8,820 1 comment 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, cnvkit/batch outputs many different types of files to individual channels which may cause confusion. A few specific examples.

Two bed files are typically generated for each process. A target.bed and a antitarget.bed. Currently both are emitted to the bed channel.

A reference.cnn file will frequently (always?) be emitted with the other .cnn files which may include tumor and normal .cnn files. In tumor-normal mode you will generate: a reference.cnn, [tumor].antitargetcoverage.cnn, [tumor].targetcoverage.cnn, [normal].targetcoverage.cnn, [normal].antitargetcoverage.cnn.

Additionally, multiple .cns files will be emitted to the same channel [tumor].call.cns, [tumor].bintest.cns, [tumor].cns.

This pattern makes it difficult to use specific files downstream.

Describe the solution you'd like

Update the output channels to be more specific and have additional outputs for the different files generated.

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

Start by locating the cnvkit/batch module and its nf-test coverage, then inspect how the target.bed, antitarget.bed, reference.cnn, other .cnn files, and .cns files are emitted. Define separate output channels for the distinct file types and update or add tests so each expected file is available downstream through the intended channel.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.