Skip to content

Release 5.4.1#991

Merged
dialvarezs merged 60 commits intomainfrom
dev
Mar 12, 2026
Merged

Release 5.4.1#991
dialvarezs merged 60 commits intomainfrom
dev

Conversation

@dialvarezs
Copy link
Copy Markdown
Member

Fixed

  • #974 - Re-add accidently removed functionality for using metaSPAdes contigs downstream rather than scaffolds (reported by @Pranjal-Bioinfo, fix by @jfy133)
  • #984 - Fix docs regarding usage of Bin QC tool scores when filtering bins for post-processing (by @dialvarezs, @claude)
  • #987 - Fix several documentation issues (by @dialvarezs)
  • #988 - Fix regarding validation of column long_reads_platform in the input samplesheet (#985 by @vinisalazar)
  • #986 - Fix faulty ALE version YAML loading resulting in a snakeyaml error (by @jfy133)

jfy133 and others added 30 commits February 2, 2026 15:38
The `gtdbtk_min_completeness` and `gtdbtk_max_contamination` parameters
previously described filtering as applying only to BUSCO quality metrics.
However, since v2.5 the pipeline supports multiple bin QC tools (BUSCO,
CheckM, CheckM2) and the filter applies to results from any/all of them.

Update help_text in nextflow_schema.json and descriptions in docs/output.md
to accurately reflect that completeness and contamination filtering works
across all available bin QC tools, not exclusively BUSCO.

Fixes #983

https://claude.ai/code/session_01GFjgJHCGv7Jn9ZEdsVMv8p
Update GTDB-Tk QC documentation to include CheckM and CheckM2
Re-add contigs vs scaffolds metaSPAdes selection
Co-authored-by: James A. Fellows Yates <[email protected]>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 7, 2026

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

Posted for pipeline commit 2f6073f

+| ✅ 382 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗   7 tests had warnings |!
Details

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 5.4.1
  • pipeline_todos - TODO string in main.nf: Remove this line if you don't need a FASTA file [TODO: try and test using for --host_fasta and --host_genome]
  • 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
  • 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!

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-03-11 10:39:25

Comment thread CHANGELOG.md Outdated
@atrull314 atrull314 self-requested a review March 9, 2026 16:09
Copy link
Copy Markdown

@famosab famosab left a comment

Choose a reason for hiding this comment

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

LGTM!
Just a few comments about the parameters :)

Comment thread docs/output.md
</details>

If the parameter `--save_checkm_reference` is set, additionally the used the CheckM reference datasets are stored in the output directory.
If the parameter `--save_checkm_data` is set, additionally the used the CheckM reference datasets are stored in the output directory.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

You could add the parameter changes to the CHANGELOG in the future.

Comment thread docs/output.md
</details>

GUNC will be run if specified with `--run_gunc` as a standalone, unless CheckM is also activated via `--qc_tool 'checkm'`, in which case GUNC output will be merged with the CheckM output using `gunc merge_checkm`.
GUNC will be run if specified with `--run_gunc` as a standalone, unless CheckM is also activated via `--run_checkm`, in which case GUNC output will be merged with the CheckM output using `gunc merge_checkm`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

As above: add parameter changes to CHANGELOG :)

Comment thread docs/usage.md
## A note on bin filtering

The pipeline offers the ability to filter out bins that fall outside of a certain size in base pairs (`--bin_max_length`, `--bin_min_length`).
The pipeline offers the ability to filter out bins that fall outside of a certain size in base pairs (`--bin_max_size`, `--bin_min_size`).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

also here

},
"SPLIT_FASTA": {
"biopython": "1.7.4",
"biopython": "1.74",
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Was this a real version update -> then CHANGELOG? But I guess it was just incorrectly reported?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Was incorrectly reported

Comment thread nextflow_schema.json
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 don't see any of the updated README parameters here in the schema? SO I guess the docs where now updated after the params have been renamed some time ago? Then you can just ignore my remark about the CHANGELOG :)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Exactly that, the docs were outdated / wrong

@dialvarezs dialvarezs merged commit 0c370ba into main Mar 12, 2026
110 of 112 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants