nf-core / nf-core/modules

Inconsistency of alignment subworkflows and aligner modules

Open
#11,138 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Have you checked the docs?
Description of the bug

Hi all,

I'm a bit puzzled. I planned to update a few things in the chipseq pipeline and stumbled across an inconsistency.
Before changing / adapting some of the rather central modules (bwa or bowtie2), I'm seeking for some advice:

Some of the alignment subworkflows use the BAM_SORT_STATS_SAMTOOLS subworkflow, which now expects a ch_fasta_fai input channel.
The subworkflows: fastq_align_bowtie2, fastq_align_bwa or fastq_align_chromap have already been adapted accordingly.

However, bowtie2 and bwa modules currently only take ch_fasta as inputs.
Example:
Subworkflow: https://github.com/nf-core/modules/blob/master/subworkflows/nf-core/fastq_align_bowtie2/main.nf

Module: https://github.com/nf-core/modules/blob/master/modules/nf-core/bowtie2/align/main.nf

I see two options:
a) adapt the inputs for bowtie2/build, bowtie2/align, bwa/index and bwa/mem (and likely also the other bwa modules).
b) just go ahead and patch things to match the pipeline needs.

If we agree on a) I wouldn't mind to update the modules and open a PR later.

All best,
Kevin

Command used and terminal output

Relevant files

No response

System information

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 comparing subworkflows/nf-core/fastq_align_bowtie2/main.nf with modules/nf-core/bowtie2/align/main.nf, then inspect the corresponding bwa and BAM_SORT_STATS_SAMTOOLS interfaces. Clarify whether the module inputs should be adapted or only the pipeline patched; done means the alignment subworkflows and modules agree on the fasta and fasta index channels.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.