Skip to content

fix(mqc): use active aligner display name for fail_mapped header#1850

Merged
pinin4fjords merged 3 commits into
devfrom
fix/multiqc-fail-mapped-header
May 8, 2026
Merged

fix(mqc): use active aligner display name for fail_mapped header#1850
pinin4fjords merged 3 commits into
devfrom
fix/multiqc-fail-mapped-header

Conversation

@pinin4fjords
Copy link
Copy Markdown
Member

Summary

  • Plumb an aligner_display_name take input through MULTIQC_RNASEQ and replace the hardcoded "STAR uniquely mapped reads (%)" header in the fail_mapped per-sample TSV with the active aligner's display name. Bowtie2 reports now correctly read Bowtie2 overall alignment rate (%).
  • Drop the hardcoded STAR reference from the pipeline-completion min_mapped_reads warning so it reads "samples skipped since they failed the X% mapped threshold" regardless of aligner.

The display name map lives at the top of RNASEQ so the subworkflow stays aligner-agnostic. Map covers star_salmon, star_rsem, hisat2, and bowtie2_salmon, with a generic 'Aligned reads' fallback for forward compatibility.

Note: HISAT2 doesn't currently surface percent_mapped to ch_percent_mapped, so its fail_mapped path is a dead branch today; the HISAT2 entry in the map is forward-looking.

Closes #1846

Test plan

  • nf-test test tests/default.nf.test --profile=+test,docker passes (STAR snapshots unchanged — display name identical)
  • Manual run on Bowtie2 path with -profile test_prokaryotic,docker --min_mapped_reads 99 produces multiqc_fail_mapped_samples_table.txt with header Sample\tBowtie2 overall alignment rate (%)
  • CI pipeline tests on the PR

🤖 Generated with Claude Code

pinin4fjords and others added 2 commits May 8, 2026 12:02
Plumb an aligner_display_name string from RNASEQ into MULTIQC_RNASEQ so
the fail_mapped per-sample TSV header reflects the metric the active
aligner actually emits, instead of always saying "STAR uniquely mapped
reads (%)". Also drop the hardcoded "STAR" reference from the
pipeline-completion warning that flags samples below min_mapped_reads.

Closes #1846

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

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

Posted for pipeline commit 5bc15d5

+| ✅ 207 tests passed       |+
#| ❔  21 tests were ignored |#
!| ❗   7 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • 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 base.config: Check the defaults for all processes
  • 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

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-05-08 13:32:07

Copy link
Copy Markdown
Contributor

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

LGTM!

@pinin4fjords
Copy link
Copy Markdown
Member Author

Thanks @vagkaratzas !

@pinin4fjords pinin4fjords merged commit add90d8 into dev May 8, 2026
116 of 120 checks passed
@pinin4fjords pinin4fjords deleted the fix/multiqc-fail-mapped-header branch May 8, 2026 14:39
@pinin4fjords pinin4fjords linked an issue May 11, 2026 that may be closed by this pull request
5 tasks
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.

MultiQC fail-mapped header is hardcoded to "STAR uniquely mapped reads (%)"

2 participants