nf-core / nf-core/mag

Compress FASTA files with contigs and scaffolds using bgzip instead of gzip, to enable file indexing

Open
#746 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Nextflow
Stars
321
Forks
156
Avg merge
12h 59m
Merged PRs (30d)
5

Description

Description of feature

Certain downstream analysis tools expect the FASTA files with contigs and scaffolds to be compressed with bgzip instead of gzip, for file indexing purposes. To save time with decompressing and recompressing, it would be helpful if the MEGAHIT and SPAdes modules would directly compress their outputs with bgzip instead of gzip.

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

Inspect the MEGAHIT and SPAdes modules and their output-compression steps first. Confirm how the current gzip handling is wired, then verify that contig and scaffold outputs use bgzip and are suitable for file indexing.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.