-
Notifications
You must be signed in to change notification settings - Fork 811
Qc optimization #1601
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
edmundmiller
wants to merge
2
commits into
dev
Choose a base branch
from
qc-optimization
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Qc optimization #1601
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | |
| #### Usage Examples | ||
|
|
||
| 1. **Forward Stranded Sample:** | ||
|
|
||
| - Forward fraction: 0.85 | ||
| - Reverse fraction: 0.15 | ||
| - **Classification:** Forward stranded | ||
|
|
||
| 2. **Reverse Stranded Sample:** | ||
|
|
||
| - Forward fraction: 0.1 | ||
| - Reverse fraction: 0.9 | ||
| - **Classification:** Reverse stranded | ||
|
|
||
| 3. **Unstranded Sample:** | ||
|
|
||
| - Forward fraction: 0.45 | ||
| - Reverse fraction: 0.55 | ||
| - **Classification:** Unstranded | ||
|
|
@@ -139,6 +142,54 @@ You can use `--skip_alignment --skip_pseudo_alignment` if you only want to run t | |
|
|
||
| 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. | ||
|
|
||
| ## Quality Control Configuration | ||
|
|
||
| ### Performance-Optimized Defaults (v4.0+) | ||
|
|
||
| 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: | ||
|
|
||
| - **`--skip_dupradar true`** - Disable dupRadar analysis (limited utility for bulk RNA-seq experiments) | ||
| - **`--skip_qualimap true`** - Disable Qualimap alignment QC (resource-intensive step) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since we're flipping the sense of the flags (and we'd have to make a major version anyway), maybe these should be renamed instead? |
||
| - **`--skip_rseqc true`** - Disable RSeQC analysis suite (7 comprehensive RNA-seq modules) | ||
| - **`--skip_stringtie true`** - Disable StringTie transcriptome assembly (additional processing overhead) | ||
| - **`--skip_bigwig true`** - Disable BigWig coverage track generation (large output files) | ||
|
|
||
| These changes can significantly reduce pipeline runtime and computational requirements while preserving essential QC metrics through FastQC, MultiQC, and basic alignment statistics. | ||
|
|
||
| ### Enabling Comprehensive QC | ||
|
|
||
| For detailed quality control analysis, you can re-enable any or all QC steps: | ||
|
|
||
| ```bash | ||
| # Enable all QC steps (restore pre-v4.0 behavior) | ||
| nextflow run nf-core/rnaseq \ | ||
| --skip_dupradar false \ | ||
| --skip_qualimap false \ | ||
| --skip_rseqc false \ | ||
| --skip_stringtie false \ | ||
| --skip_bigwig false | ||
|
|
||
| # Enable specific QC modules only | ||
| nextflow run nf-core/rnaseq --skip_qualimap false --skip_rseqc false | ||
|
|
||
| # Use the master QC toggle to enable most QC steps | ||
| nextflow run nf-core/rnaseq --skip_qc false | ||
| ``` | ||
|
|
||
| ### When to Enable Extended QC | ||
|
|
||
| Consider enabling additional QC steps when: | ||
|
|
||
| - Working with novel samples, non-standard protocols, or unusual experimental designs | ||
| - Troubleshooting alignment, quantification, or data quality issues | ||
| - Publishing datasets that require comprehensive QC documentation | ||
| - Optimizing library preparation or sequencing protocols | ||
| - Performing method comparisons or validation studies | ||
|
|
||
| :::note | ||
| Essential QC steps like FastQC, MultiQC, and alignment metrics remain enabled by default and provide sufficient quality assessment for most RNA-seq analyses. | ||
| ::: | ||
|
|
||
| ### Sentieon acceleration for STAR | ||
|
|
||
| The STAR aligner can be accelerated through its Sentieon implemention using the parameter `--use_sentieon_star`. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you qualify the reasoning behind the 'limited utility' assertion please?