Make QC steps opt-in
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 10
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Propose making computationally expensive QC steps opt-in across nf-core pipelines via a --run_qc parameter, improving default pipeline performance while maintaining QC capabilities for users who need them.
Champion
@ewels @edmundmiller
Background & Motivation
Many QC steps across nf-core pipelines are computationally expensive and can be the slowest-running parts of the entire workflow. Examples include:
- preseq in methylseq
- Qualimap in both rnaseq and methylseq
Not all users need comprehensive QC for every run, particularly in production environments or when running on large datasets. The current default behavior forces all QC steps to run, regardless of user needs, which significantly impacts runtime and resource usage.
There's a need to establish sane defaults that balance comprehensive quality control with practical performance considerations, while still making it easy for users who need full QC to enable it.
Goals
- Make expensive QC steps opt-in via a
--run_qcparameter (or similar mechanism) - Improve default pipeline runtime and resource efficiency for typical use cases
- Maintain easy access to comprehensive QC for users who need it
- Start with the Very Important Pipelines to establish patterns
Non-Goals
- Removing QC functionality entirely from pipelines
- Breaking existing workflows without providing an easy migration path
- Making QC so hidden that new users don't discover it exists
References
- Original Slack discussion: https://nfcore.slack.com/archives/CP3RJSMF0/p1732017304977949?thread_ts=1731878973.258839&cid=CP3RJSMF0
- Related methylseq discussion on making preseq opt-in
Contributor guide
No contributing guide indexed for this repository
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
Start by reviewing the Very Important Pipelines and the existing QC steps named in the proposal, especially preseq in methylseq and Qualimap in rnaseq and methylseq. Define a consistent opt-in parameter pattern, preserve access to QC, and confirm that default runs avoid expensive QC without breaking existing workflows or hiding the option.
Written by the indexing model from the issue text.
Assessment
- Domain
- bioinformatics
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100