Skip to content

Fix versions of modules from GDTBTk not being reported in MultiQC and version.yaml#850

Merged
jfy133 merged 3 commits intodevfrom
fix_gdtbtk_version_reporting
Aug 15, 2025
Merged

Fix versions of modules from GDTBTk not being reported in MultiQC and version.yaml#850
jfy133 merged 3 commits intodevfrom
fix_gdtbtk_version_reporting

Conversation

@jfy133
Copy link
Copy Markdown
Member

@jfy133 jfy133 commented Aug 15, 2025

Closes #761

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

@jfy133 jfy133 linked an issue Aug 15, 2025 that may be closed by this pull request
Fix version reporting for all subworkflows #761
Closed
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 15, 2025 •
edited
Loading

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

Posted for pipeline commit 5d400ae

+| ✅ 360 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗  48 tests had warnings |!
Details

❗ Test warnings:

  • 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 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 nextflow.config: Specify any additional parameters here
  • 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
  • local_component_structure - bowtie2_assembly_align.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - adjust_maxbin2_ext.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bin_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - gtdbtk_db_preparation.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_removal_build.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - pool_paired_reads.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast_bins.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - rename_postdastool.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - tiara_classify.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - rename_predastool.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - gtdbtk_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_removal_align.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - nanolyse.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - split_fasta.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_assembly_build.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - convert_depths.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast_bins_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths_plot.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - pool_single_reads.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - domain_classification.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - tiara.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - ancient_dna.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - catpack.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - hybrid_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - depths.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - gtdbtk.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - virus_identification.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - bin_qc.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - binning.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - binning_refinement.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

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

✅ Tests passed:

Run details

  • nf-core/tools version 3.3.2
  • Run at 2025-08-15 13:30:55

fellen31
fellen31 approved these changes Aug 15, 2025
View reviewed changes
Copy link
Copy Markdown

@fellen31 fellen31 left a comment

Choose a reason for hiding this comment

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

👍

jfy133
jfy133 commented Aug 15, 2025
View reviewed changes
Comment thread CHANGELOG.md Outdated
fellen31
fellen31 reviewed Aug 15, 2025
View reviewed changes
Copy link
Copy Markdown

@fellen31 fellen31 left a comment

Choose a reason for hiding this comment

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

Sorry, was a bit quick there. No test snapshots that would be updated?

Comment thread CHANGELOG.md Outdated

- [#843](https://github.com/nf-core/mag/pull/843) - Fixed issue with large format Bowtie2 index files not being emitted from index module (reported by Nick Eckersley, fix by @jfy133)
- [#847](https://github.com/nf-core/mag/pull/847) - Allow the BBNorm process to use only 0.8 of the memory allocated to the task to stop if from oversubscribing memory (reported by and fix by @erikrikarddaniel)
- [#855](https://github.com/nf-core/mag/pull/855) - Fixed some modules of the GDTBTk subworkflow not being represented in version lists (reported by @user, fix by @jfy133)
Copy link
Copy Markdown

@fellen31 fellen31 Aug 15, 2025

Choose a reason for hiding this comment

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

Fill in @user here?

Suggested change
- [#855](https://github.com/nf-core/mag/pull/855) - Fixed some modules of the GDTBTk subworkflow not being represented in version lists (reported by @user, fix by @jfy133)
- [#855](https://github.com/nf-core/mag/pull/855) - Fixed some modules of the GDTBTk subworkflow not being represented in version lists (reported by @user, fix by @jfy133)

@jfy133
Copy link
Copy Markdown
Member Author

jfy133 commented Aug 15, 2025

Sorry, was a bit quick there. No test snapshots that would be updated?

We haven't got that far with mag (mag is a big scary grandpa pipeline) but normally would've been a good catch!

jfy133
jfy133 commented Aug 15, 2025
View reviewed changes
Comment thread CHANGELOG.md Outdated
fellen31
fellen31 approved these changes Aug 15, 2025
View reviewed changes
Copy link
Copy Markdown

@fellen31 fellen31 left a comment

Choose a reason for hiding this comment

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

LGTM!

@jfy133 jfy133 merged commit 4ad8d5e into dev Aug 15, 2025
12 checks passed
@dialvarezs dialvarezs deleted the fix_gdtbtk_version_reporting branch November 21, 2025 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fellen31 fellen31 fellen31 approved these changes

@d4straub d4straub Awaiting requested review from d4straub d4straub is a code owner

@prototaxites prototaxites Awaiting requested review from prototaxites prototaxites is a code owner

@muabnezor muabnezor Awaiting requested review from muabnezor muabnezor is a code owner

@dialvarezs dialvarezs Awaiting requested review from dialvarezs dialvarezs is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix version reporting for all subworkflows

2 participants

@jfy133 @fellen31