Skip to content

Conversation

edmundmiller
Copy link
Contributor

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/rnaseq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

edmundmiller and others added 2 commits August 22, 2025 10:09
- Set skip_dupradar=true (mostly pointless for bulk RNA-seq)
- Set skip_qualimap=true (identified as slowest QC step)
- Set skip_rseqc=true (7 resource-intensive modules by default)
- Set skip_stringtie=true (additional assembly overhead)
- Set skip_bigwig=true (coverage track generation overhead)

Follows nf-core/proposals#71 to make QC steps opt-in rather than
mandatory. Users can re-enable comprehensive QC via parameters when needed.
Significantly reduces pipeline runtime and compute costs for standard
bulk RNA-seq workflows.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: adamrtalbot <adamrtalbot@users.noreply.github.com>
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 link

github-actions bot commented Aug 22, 2025

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit dc03136

+| ✅ 295 tests passed       |+
#| ❔   7 tests were ignored |#
!| ❗   9 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: assets/multiqc_config.yml
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_if_empty_null - ifEmpty(null) found in main.nf: _ versions = ch_versions.ifEmpty(null) // channel: [ versions.yml ]
    _

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.3.2
  • Run at 2025-08-22 15:13:11

Copy link
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no objection to a bit of polar-bear saving, but I'd like a bit of explanation about why some of the options aren't widely useful. I also think it would make sense to leave them as flags but flip the sense.


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)
Copy link
Member

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?

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)
Copy link
Member

Choose a reason for hiding this comment

The 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? --run_qualimap etc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants