Skip to content

Fix 'multiqc_title' param modifying the output multiqc directory structure - #265

Open
pontushojer wants to merge 2 commits into
nf-core:devfrom
pontushojer:fix-261
Open

Fix 'multiqc_title' param modifying the output multiqc directory structure#265
pontushojer wants to merge 2 commits into
nf-core:devfrom
pontushojer:fix-261

Conversation

@pontushojer

Copy link
Copy Markdown
Contributor

fix #261

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/seqinspector 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).

Copilot AI review requested due to automatic review settings July 29, 2026 09:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses nf-core/seqinspector issue #261 by ensuring that using --multiqc_title does not alter MultiQC output filenames and directories, which would otherwise break the report index links.

Changes:

  • Pin MultiQC output names (multiqc_report.html, multiqc_data, multiqc_plots) in assets/multiqc_config.yml so they stay stable even when --multiqc_title is set.
  • Add a changelog entry documenting the fix and linking the relevant issue and PR.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
assets/multiqc_config.yml Forces static MultiQC output filenames and directory names to prevent --multiqc_title from changing output structure.
CHANGELOG.md Documents the fix and links to the relevant PR and issue.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread assets/multiqc_config.yml
Comment on lines +17 to +21
# Set static output file names for the report, data and plots directories so these
# are not changed when "--multiqc_title" is specified, required for index section to work properly
output_fn_name: "multiqc_report.html"
data_dir_name: "multiqc_data"
plots_dir_name: "multiqc_plots"
@pontushojer pontushojer linked an issue Jul 29, 2026 that may be closed by this pull request
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.

wrong link to global report in MultiQC

2 participants