Skip to content

Add a QC report using Quarto#258

Open
fasterius wants to merge 98 commits intonf-core:devfrom
NBISweden:qc-reports
Open

Add a QC report using Quarto#258
fasterius wants to merge 98 commits intonf-core:devfrom
NBISweden:qc-reports

Conversation

@fasterius
Copy link
Contributor

@fasterius fasterius commented Mar 11, 2026

This PR adds an HTML QC report using Quarto. It currently takes the available outputs of the pipeline and collects them into a single, curated report, along with small explanations and the nf-core visual identity. More functionality is desired, but will require changes/additions to the pipeline itself (e.g. adding ribosomal content), so will be added in future PRs.

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
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

fasterius and others added 30 commits May 21, 2025 11:14
Make the QUARTONOTEBOOK module handle collected data (samples) instead
of working in a per-sample basis, as multiple inputs are desired for the
QC reporting. The changes are applied through a module patch.
@fasterius fasterius marked this pull request as ready for review March 17, 2026 18:06
@fasterius fasterius requested a review from nictru as a code owner March 17, 2026 18:06
@fasterius
Copy link
Contributor Author

fasterius commented Mar 17, 2026

I think this is ready for review now. I'll need some help with updating snapshots, as neither my local system nor the HPC I have access to yields the same snapshots as GHA due to the previously discussed rounding issues.

Currently, this PR doesn't touch the existing MultiQC report, but this could be added if desired. One alternative would be to remove all the figures/tables currently included in the MultiQC report, but still keep it for keeping track of module versions, workflow summary, etc. - I don't think it should be removed entirely.

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.

3 participants