You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,9 @@ Special thanks to the following for their contributions to the release:
14
14
### Enhancements & fixes
15
15
16
16
-[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
Copy file name to clipboardExpand all lines: docs/output.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -381,6 +381,10 @@ Unless you are using [UMIs](https://emea.illumina.com/science/sequencing-method-
381
381
382
382
### StringTie
383
383
384
+
:::note
385
+
StringTie is disabled by default starting in v4.0 to improve pipeline performance. Enable with `--skip_stringtie false`.
386
+
:::
387
+
384
388
<detailsmarkdown="1">
385
389
<summary>Output files</summary>
386
390
@@ -396,6 +400,10 @@ Unless you are using [UMIs](https://emea.illumina.com/science/sequencing-method-
396
400
397
401
### BEDTools and bedGraphToBigWig
398
402
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
+
399
407
<detailsmarkdown="1">
400
408
<summary>Output files</summary>
401
409
@@ -411,6 +419,10 @@ The [bigWig](https://genome.ucsc.edu/goldenpath/help/bigWig.html) format is an i
411
419
412
420
### RSeQC
413
421
422
+
:::note
423
+
RSeQC analysis is disabled by default starting in v4.0 to improve pipeline performance. Enable with `--skip_rseqc false`.
424
+
:::
425
+
414
426
[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`.
415
427
416
428
The majority of RSeQC scripts generate output files which can be plotted and summarised in the MultiQC report.
Qualimap analysis is disabled by default starting in v4.0 due to its resource-intensive nature. Enable with `--skip_qualimap false`.
608
+
:::
609
+
594
610
<detailsmarkdown="1">
595
611
<summary>Output files</summary>
596
612
@@ -616,6 +632,10 @@ The [Qualimap RNA-seq QC module](http://qualimap.bioinfo.cipf.es/doc_html/analys
616
632
617
633
### dupRadar
618
634
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`.
Copy file name to clipboardExpand all lines: docs/usage.md
+51Lines changed: 51 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,16 +46,19 @@ If you set the strandedness value to `auto`, the pipeline will sub-sample the in
46
46
#### Usage Examples
47
47
48
48
1.**Forward Stranded Sample:**
49
+
49
50
- Forward fraction: 0.85
50
51
- Reverse fraction: 0.15
51
52
-**Classification:** Forward stranded
52
53
53
54
2.**Reverse Stranded Sample:**
55
+
54
56
- Forward fraction: 0.1
55
57
- Reverse fraction: 0.9
56
58
-**Classification:** Reverse stranded
57
59
58
60
3.**Unstranded Sample:**
61
+
59
62
- Forward fraction: 0.45
60
63
- Reverse fraction: 0.55
61
64
-**Classification:** Unstranded
@@ -139,6 +142,54 @@ You can use `--skip_alignment --skip_pseudo_alignment` if you only want to run t
139
142
140
143
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.
141
144
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:
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
+
142
193
### Sentieon acceleration for STAR
143
194
144
195
The STAR aligner can be accelerated through its Sentieon implemention using the parameter `--use_sentieon_star`.
0 commit comments