Skip to content

Release v1.1.2#292

Merged
Joon-Klaps merged 65 commits into
mainfrom
dev
Jun 3, 2026
Merged

Release v1.1.2#292
Joon-Klaps merged 65 commits into
mainfrom
dev

Conversation

@Joon-Klaps

Copy link
Copy Markdown
Collaborator

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

Joon-Klaps and others added 30 commits March 31, 2026 09:37
Bump versions back to dev `1.1.2dev`
Introduce a new polishing parameter, cluster_with_reference, with a default value of true.

This commit only adds the public parameter surface in nextflow.config and nextflow_schema.json. It does not change workflow behavior yet.

The intent is to preserve the current default behavior while preparing a later commit that will make BLAST-based reference injection into clustering optional. Keeping the plumbing isolated makes the eventual PR easier to review and keeps this commit bisectable on its own.
Wire cluster_with_reference into FASTA_CONTIG_CLUST so BLAST can continue to run while the FASTA passed into clustering becomes configurable.

When cluster_with_reference is true, keep the current behavior and cluster contigs together with BLAST-hit references. When it is false, still run BLAST and preserve its outputs, but use only the de novo contigs for clustering-related downstream steps.

This commit is intentionally limited to the workflow behavior change. It does not update tests or documentation yet.
Add the minimum maintainer-friendly test coverage for cluster_with_reference=false.

This commit should keep the focus on proving the feature contract rather than trying to validate full biological correctness. The goals are to preserve backward compatibility, verify that the new mode runs successfully, and add a small amount of evidence that clustering can proceed without injecting BLAST-hit references.

Documentation changes remain separate in the next commit.
Update the polishing and output documentation to describe cluster_with_reference and clarify how BLAST-derived references participate in clustering.

This commit should make it clear that BLAST still runs in both modes, that reference injection into clustering is now optional, and that _withref outputs are intermediate BLAST-filter artifacts rather than unconditional clustering inputs.
make blast reference injection into clustering optional
Signed-off-by: Joon Klaps <joon.klaps@kuleuven.be>
@Joon-Klaps Joon-Klaps changed the title Dev Release v1.1.2 May 18, 2026
Fix undetected conda issues with dev branch

@charles-plessy charles-plessy 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.

I have minor comments, but overall it looks good to me.

Comment thread CHANGELOG.md
Comment thread modules.json
"multiqc": {
"branch": "master",
"git_sha": "2c73cc8fa92cf48de3da0b643fdf357a8a290b36",
"git_sha": "008f9d3e61209bf995edac3ba531f54e269e1215",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please document the bump of version in the changelog.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

While we do have the nf-core/modules/multiqc I don't actually use it, we use a local/custom_multiqc where I call the API of multiqc in a python script for custom output formatting. I keep nf-core/modules/multiqc as it's usefull to get all the relevant template updates around it (software versions, custom methods, ...)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So you don't run multiqc directly in the pipeline?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

No no, I do, It's just wrapped inside a local module.
https://github.com/nf-core/viralmetagenome/blob/dev/modules/local/custom_multiqc/main.nf

The main logic here comes from that we have a 1 sample to many different genome, which highly pollutes the mqc report.html making it sometimes 2-3GB large. So I needed to come up with a solution which was, I keep all important sample specific results within mqc file but combine all genome specific results into overview tables.

Comment thread nextflow_schema.json
Comment thread .gitignore
Comment thread nextflow.config Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I advise in removing params from any .nf file except for the root main.nf.
But not blocking for this release

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah... it's someting I've been postponing. I'll make an issue and try and include in the next minor release.

Joon-Klaps and others added 2 commits June 2, 2026 15:39
Co-authored-by: Maxime U Garcia <max.u.garcia@gmail.com>
Signed-off-by: Joon Klaps <joon.klaps@kuleuven.be>
Signed-off-by: Joon Klaps <joon.klaps@kuleuven.be>
@Joon-Klaps

Copy link
Copy Markdown
Collaborator Author

@maxulysse anything else you think i should adresss before this patch release?

@maxulysse maxulysse left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Joon-Klaps Joon-Klaps merged commit 3a21c87 into main Jun 3, 2026
106 checks passed
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.

5 participants