nf-core / nf-core/modules

Skip indexing for bam_sort_stats_samtools

Open
#10,390 0 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

Samtools sort has been updated a while ago so that it can automatically add the index (crai/bai) of a bam file. I feel like the index step in the BAM_SORT_STATS_SAMTOOLS subworkflow is unneeded and can be replaced by taking an extra argument of the type of index you want and simply use the samtools sort to directly sort and index sam/bam files.

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 BAM_SORT_STATS_SAMTOOLS subworkflow and reviewing how its separate index step currently follows Samtools sort. Check the Samtools sort behavior described in the issue, then update the subworkflow so the requested index type is passed as an argument and sorting produces the index directly. Done means the redundant index step is removed while SAM/BAM sorting and indexing still work.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.