Skip to content

Commit 317d030

Browse files
edmundmillerclaude
andcommitted
docs: document QC optimization changes for v4.0
Add comprehensive documentation for the performance-optimized QC defaults: - Add "Quality Control Configuration" section to usage.md explaining the v4.0 changes - Document which QC steps are now disabled by default and why - Provide clear commands to restore comprehensive QC when needed - Add guidance on when to enable extended QC analysis - Update all affected QC sections in output.md with proper admonition notes - Use consistent :::note syntax following nf-core documentation standards Updates changelog with breaking changes and performance improvements. Helps users understand the new defaults and migrate their workflows appropriately. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent b69c3b9 commit 317d030

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ Special thanks to the following for their contributions to the release:
1414
### Enhancements & fixes
1515

1616
- [PR #1597](https://github.com/nf-core/rnaseq/pull/1597) - Bump version after release 3.20.0
17+
- **BREAKING:** Optimize default QC steps for performance - `skip_dupradar`, `skip_qualimap`, `skip_rseqc`, `skip_stringtie`, and `skip_bigwig` now default to `true` to improve pipeline runtime and reduce compute costs. Use `--skip_[tool] false` to restore previous behavior
18+
- Optimize RSEM performance for Fusion filesystem by using local temporary storage and scratch directive
19+
- Add fast mode optimization to dupRadar module for improved performance
1720

1821
## [[3.20.0](https://github.com/nf-core/rnaseq/releases/tag/3.20.0)] - 2025-08-18
1922

docs/output.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,10 @@ Unless you are using [UMIs](https://emea.illumina.com/science/sequencing-method-
381381

382382
### StringTie
383383

384+
:::note
385+
StringTie is disabled by default starting in v4.0 to improve pipeline performance. Enable with `--skip_stringtie false`.
386+
:::
387+
384388
<details markdown="1">
385389
<summary>Output files</summary>
386390

@@ -396,6 +400,10 @@ Unless you are using [UMIs](https://emea.illumina.com/science/sequencing-method-
396400

397401
### BEDTools and bedGraphToBigWig
398402

403+
:::note
404+
BigWig generation is disabled by default starting in v4.0 to reduce output file sizes and improve performance. Enable with `--skip_bigwig false`.
405+
:::
406+
399407
<details markdown="1">
400408
<summary>Output files</summary>
401409

@@ -411,6 +419,10 @@ The [bigWig](https://genome.ucsc.edu/goldenpath/help/bigWig.html) format is an i
411419

412420
### RSeQC
413421

422+
:::note
423+
RSeQC analysis is disabled by default starting in v4.0 to improve pipeline performance. Enable with `--skip_rseqc false`.
424+
:::
425+
414426
[RSeQC](<(http://rseqc.sourceforge.net/)>) is a package of scripts designed to evaluate the quality of RNA-seq data. This pipeline runs several, but not all RSeQC scripts. You can tweak the supported scripts you would like to run by adjusting the `--rseqc_modules` parameter which by default will run all of the following: `bam_stat.py`, `inner_distance.py`, `infer_experiment.py`, `junction_annotation.py`, `junction_saturation.py`,`read_distribution.py` and `read_duplication.py`.
415427

416428
The majority of RSeQC scripts generate output files which can be plotted and summarised in the MultiQC report.
@@ -591,6 +603,10 @@ RSeQC documentation: [tin.py](http://rseqc.sourceforge.net/#tin-py)
591603

592604
### Qualimap
593605

606+
:::note
607+
Qualimap analysis is disabled by default starting in v4.0 due to its resource-intensive nature. Enable with `--skip_qualimap false`.
608+
:::
609+
594610
<details markdown="1">
595611
<summary>Output files</summary>
596612

@@ -616,6 +632,10 @@ The [Qualimap RNA-seq QC module](http://qualimap.bioinfo.cipf.es/doc_html/analys
616632

617633
### dupRadar
618634

635+
:::note
636+
dupRadar analysis is disabled by default starting in v4.0 as it provides limited utility for bulk RNA-seq experiments. Enable with `--skip_dupradar false`.
637+
:::
638+
619639
<details markdown="1">
620640
<summary>Output files</summary>
621641

docs/usage.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,19 @@ If you set the strandedness value to `auto`, the pipeline will sub-sample the in
4646
#### Usage Examples
4747

4848
1. **Forward Stranded Sample:**
49+
4950
- Forward fraction: 0.85
5051
- Reverse fraction: 0.15
5152
- **Classification:** Forward stranded
5253

5354
2. **Reverse Stranded Sample:**
55+
5456
- Forward fraction: 0.1
5557
- Reverse fraction: 0.9
5658
- **Classification:** Reverse stranded
5759

5860
3. **Unstranded Sample:**
61+
5962
- Forward fraction: 0.45
6063
- Reverse fraction: 0.55
6164
- **Classification:** Unstranded
@@ -139,6 +142,54 @@ You can use `--skip_alignment --skip_pseudo_alignment` if you only want to run t
139142

140143
Note that `--skip_alignment` and `--skip_pseudo_alignment` prevent both the execution of alignment/pseudoalignment steps and the building of their corresponding indices. For example, using `--skip_alignment` with `--aligner star_salmon` will skip both STAR alignment and index building.
141144

145+
## Quality Control Configuration
146+
147+
### Performance-Optimized Defaults (v4.0+)
148+
149+
Starting in version 4.0, several QC steps are disabled by default to improve pipeline performance and reduce compute costs for typical bulk RNA-seq analysis:
150+
151+
- **`--skip_dupradar true`** - Disable dupRadar analysis (limited utility for bulk RNA-seq experiments)
152+
- **`--skip_qualimap true`** - Disable Qualimap alignment QC (resource-intensive step)
153+
- **`--skip_rseqc true`** - Disable RSeQC analysis suite (7 comprehensive RNA-seq modules)
154+
- **`--skip_stringtie true`** - Disable StringTie transcriptome assembly (additional processing overhead)
155+
- **`--skip_bigwig true`** - Disable BigWig coverage track generation (large output files)
156+
157+
These changes can significantly reduce pipeline runtime and computational requirements while preserving essential QC metrics through FastQC, MultiQC, and basic alignment statistics.
158+
159+
### Enabling Comprehensive QC
160+
161+
For detailed quality control analysis, you can re-enable any or all QC steps:
162+
163+
```bash
164+
# Enable all QC steps (restore pre-v4.0 behavior)
165+
nextflow run nf-core/rnaseq \
166+
--skip_dupradar false \
167+
--skip_qualimap false \
168+
--skip_rseqc false \
169+
--skip_stringtie false \
170+
--skip_bigwig false
171+
172+
# Enable specific QC modules only
173+
nextflow run nf-core/rnaseq --skip_qualimap false --skip_rseqc false
174+
175+
# Use the master QC toggle to enable most QC steps
176+
nextflow run nf-core/rnaseq --skip_qc false
177+
```
178+
179+
### When to Enable Extended QC
180+
181+
Consider enabling additional QC steps when:
182+
183+
- Working with novel samples, non-standard protocols, or unusual experimental designs
184+
- Troubleshooting alignment, quantification, or data quality issues
185+
- Publishing datasets that require comprehensive QC documentation
186+
- Optimizing library preparation or sequencing protocols
187+
- Performing method comparisons or validation studies
188+
189+
:::note
190+
Essential QC steps like FastQC, MultiQC, and alignment metrics remain enabled by default and provide sufficient quality assessment for most RNA-seq analyses.
191+
:::
192+
142193
### Sentieon acceleration for STAR
143194

144195
The STAR aligner can be accelerated through its Sentieon implemention using the parameter `--use_sentieon_star`.

0 commit comments

Comments
 (0)