nf-core / nf-core/modules

[FEATURE] bbmap/align control output better

Open
#6,689 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement wishlist
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

I'm using bbmap.sh to filter out host reads (paired-end or not) from metagenomics data. What I'd actually want is to keep only the unmapped reads, in one file if input is single end, and in two separate files otherwise (if possible as fastq.gz), as do other bbmap modules (bbduk or filterbyname).

Describe the solution you'd like

Being able to set the output format and whether we want a single file or not, as is done in filterbyname and being able to set whether we want all the reads, only the mapped or only the unmapped reads (i.e. set out, outm or outu for the output).

Describe alternatives you've considered

I could set outu and outu2 in process.ext.args but would need to use .bam extension to have the corresponding files returned and then I'd need to pick the correct files from the channel. Moreover I'd be writing a very large file with all the reads that I don't need...

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 bbmap/align module and comparing its output handling with filterbyname/main.nf lines 28-30. Done means the module can select all, mapped, or unmapped reads and supports appropriate single-end or paired-end output formats, including fastq.gz where possible.

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
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.