Skip to content

Commit 84c35ee

Browse files
authored
Merge pull request #1625 from nf-core/docs-qualimap-limitation
Document Qualimap read counting limitation
2 parents 1e56dca + a353fa4 commit 84c35ee

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Special thanks to the following for their contributions to the release:
2020
- [PR #1614](https://github.com/nf-core/rnaseq/pull/1614) - Template update for nf-core/tools v3.4.1
2121
- [PR #1618](https://github.com/nf-core/rnaseq/pull/1618) - Fix CI: Ensure confirm-pass job runs for markdown-only PRs
2222
- [PR #1617](https://github.com/nf-core/rnaseq/pull/1617) - Update bbmap/bbsplit module
23+
- [PR #1625](https://github.com/nf-core/rnaseq/pull/1625) - Add documentation warning about Qualimap read counting bug ([#1273](https://github.com/nf-core/rnaseq/issues/1273))
2324
- [PR #1622](https://github.com/nf-core/rnaseq/pull/1622) - Update tximeta/tximport module to fix sample name mangling
2425
- [PR #1620](https://github.com/nf-core/rnaseq/pull/1620) - Fix bigwig strand labeling for reverse-stranded libraries ([#1591](https://github.com/nf-core/rnaseq/issues/1591))
2526
- [PR #1621](https://github.com/nf-core/rnaseq/pull/1621) - Optimize qualimap performance with multi-threaded name sorting

docs/output.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,18 @@ RSeQC documentation: [tin.py](http://rseqc.sourceforge.net/#tin-py)
614614

615615
The [Qualimap RNA-seq QC module](http://qualimap.bioinfo.cipf.es/doc_html/analysis.html#rna-seq-qc) is used within this pipeline to assess the overall mapping and coverage relative to gene features.
616616

617+
:::warning
618+
**Known limitation**: Qualimap has a known bug ([#1273](https://github.com/nf-core/rnaseq/issues/1273), [Qualimap issue #81](https://bitbucket.org/kokonech/qualimap/issues/81)) where it may report more reads assigned to genomic features (exons, introns, intergenic regions) than the total number of reads in the BAM file. This can lead to inflated read counts and incorrect genomic origin statistics.
619+
620+
If accurate read distribution metrics are critical for your analysis, we recommend:
621+
622+
- Cross-referencing Qualimap results with RSeQC output (particularly `read_distribution.txt`)
623+
- Using `--skip_qualimap` to disable Qualimap and rely on RSeQC for genomic feature distribution
624+
- Validating suspicious results with alternative tools or custom scripts
625+
626+
This is an upstream tool issue that cannot be fixed at the pipeline level.
627+
:::
628+
617629
![MultiQC - Qualimap gene coverage plot](images/mqc_qualimap_coverage.png)
618630

619631
![MultiQC - Qualimap genomic origin plot](images/mqc_qualimap_features.png)

0 commit comments

Comments
 (0)