bakta/bakta: gzip output files
Nobody has claimed this yet.
- Dominant language
- Nextflow
- Stars
- 429
- Forks
- 1.1k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 153
Description
Description of feature
Bakta annotates genomes and writes a set of text-format output files (.embl, .faa, .ffn, .fna, .gbff, .gff3, .hypotheticals.tsv, .hypotheticals.faa, .tsv, .txt, .json), none of which are currently compressed by the bakta/bakta module. Several of these (.embl, .gbff, .fna, .ffn) can get large for bigger genomes/collections, and per the nf-core component review checklist, large outputs should be gzipped where the downstream tooling allows it.
We carry a local patch in nf-core/magmap that gzips all of Bakta's outputs (writing them into a ${prefix}/ subdirectory and running gzip ${prefix}/* at the end of the script), used across a run that maps against potentially large genome collections where the annotation output volume adds up. Flagging this as a candidate for the upstream module rather than keeping it local-only, in case it's useful more broadly. Happy to open a PR with the change if that's welcome — wanted to check first since it changes the output paths/extensions. I suppose this could be controlled by a value argument to the module.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the bakta/bakta module and its nf-test coverage, then read how output files and paths are currently declared. Check the module conventions for optional parameters and compressed outputs before deciding how the requested gzip behavior should be exposed. Done means the intended Bakta outputs are compressed without breaking declared paths, and the module tests cover the resulting outputs.
Written by the indexing model from the issue text.
Assessment
- Domain
- bioinformatics
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100