Skip to content

Edit multiQC report#53

Merged
KateSakharova merged 42 commits intodevfrom
feature/multiqc-citations
May 6, 2026
Merged

Edit multiQC report#53
KateSakharova merged 42 commits intodevfrom
feature/multiqc-citations

Conversation

@KateSakharova
Copy link
Copy Markdown
Contributor

@KateSakharova KateSakharova commented Apr 24, 2026

  1. Fixing Create citations functions required by template #49

  2. add final reports with metadata, samples and ERZs into multiqc.html

  3. Fixing [ENA] For metagenomic assemblies the pipeline should inform users that ERZ accessions are just temporary #25 by adding note to README and info to muliqc report

  4. some minor fixes

  5. I have changed container ena-webin+newer toolkit and it seems resolved Include webin-cli jar into container, remove ENA_WEBIN_CLI_DOWNLOAD module #50

  6. Resolved annoying Update pipeline to use MultiQC of latest version #46 issue with creating seqera containers image with linux/arm64 instead of linux/amd64 🤦‍♀️

TODO: update genome_uploader after EBI-Metagenomics/genome_uploader#49 because header is required for multiqc

TODO: fix snapshots after all previous TODOs are done

@nf-core-bot
Copy link
Copy Markdown
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.5.1.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 24, 2026

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

Posted for pipeline commit bbfcaf0

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

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • 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
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • local_component_structure - rna_detection.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - genome_evaluation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • nextflow_config - Config variable ignored: params.input
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/nf-core-seqsubmit_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-seqsubmit_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-seqsubmit_logo_dark.png

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.1
  • Run at 2026-05-06 13:02:52

@KateSakharova KateSakharova force-pushed the feature/multiqc-citations branch from afd12b6 to 526e845 Compare April 28, 2026 12:27
@KateSakharova KateSakharova force-pushed the feature/multiqc-citations branch from 8ebdd5a to e3b8072 Compare April 28, 2026 15:06
@KateSakharova KateSakharova marked this pull request as ready for review April 29, 2026 14:25
@KateSakharova KateSakharova changed the title add citations Edit multiQC report Apr 29, 2026
Copy link
Copy Markdown
Collaborator

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

Minor things to remove and looks good so far! Let's wait for new nf-core tools patch updates for the next ones

Comment thread docs/output.md Outdated
> As all assemblies in ENA are submitted as ‘analyses’, for each assembly submission, Webin will report a unique accession number that starts with ERZ.
> For most assemblies, this accession number is for **internal processing only** and will not be visible in the browser.
> As a result, for most assemblies you will receive additional post-processing accession numbers starting with GCA\_.
> More information about accessions can be found in ENA docs: https://ena-docs.readthedocs.io/en/latest/submit/assembly.html#accessions.'
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
> More information about accessions can be found in ENA docs: https://ena-docs.readthedocs.io/en/latest/submit/assembly.html#accessions.'
> More information about accessions can be found in ENA docs: https://ena-docs.readthedocs.io/en/latest/submit/assembly.html#accessions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this should be in the MAGs/bins section
And specify that it's for MAGs only.
Because it's something that we know for sure.

I know that ERZs for bins and primary metagenomes ARE displayed on the portal and they are used to reference the data forever. Docs state the opposite, but I would ask ENA before assume that it's true for ALL assemblies :/

Comment thread subworkflows/local/utils_nfcore_seqsubmit_pipeline/main.nf Outdated
Comment thread subworkflows/local/utils_nfcore_seqsubmit_pipeline/main.nf Outdated
Comment thread conf/modules.config
Comment thread assets/multiqc_config.yml
Comment thread docs/output.md Outdated
> As all assemblies in ENA are submitted as ‘analyses’, for each assembly submission, Webin will report a unique accession number that starts with ERZ.
> For most assemblies, this accession number is for **internal processing only** and will not be visible in the browser.
> As a result, for most assemblies you will receive additional post-processing accession numbers starting with GCA\_.
> More information about accessions can be found in ENA docs: https://ena-docs.readthedocs.io/en/latest/submit/assembly.html#accessions.'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this should be in the MAGs/bins section
And specify that it's for MAGs only.
Because it's something that we know for sure.

I know that ERZs for bins and primary metagenomes ARE displayed on the portal and they are used to reference the data forever. Docs state the opposite, but I would ask ENA before assume that it's true for ALL assemblies :/

Comment thread modules/local/ena_webin_cli_wrapper/main.nf
Comment thread subworkflows/local/utils_nfcore_seqsubmit_pipeline/main.nf Outdated
Comment thread workflows/assemblysubmit.nf Outdated
Comment thread docs/output.md Outdated
Comment thread modules/local/ena_webin_cli_wrapper/main.nf
Comment thread workflows/genomesubmit.nf
Comment on lines +333 to +341
def topic_versions_string = topic_versions.versions_tuple
.map { process, tool, version ->
[ process[process.lastIndexOf(':')+1..-1], " ${tool}: ${version}" ]
}
.groupTuple(by:0)
.map { process, tool_versions ->
tool_versions.unique().sort()
"${process}:\n${tool_versions.join('\n')}"
}
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I know this is nf-core stuff, but this code is awful... this should be buried in a lib somewhere

Comment thread assets/multiqc_config.yml Outdated
Comment thread assets/multiqc_config.yml Outdated
Comment thread docs/output.md Outdated
Comment thread docs/output.md Outdated
Copy link
Copy Markdown
Collaborator

@mberacochea mberacochea left a comment

Choose a reason for hiding this comment

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

Left some tiny comments 🥇

Comment thread modules/local/ena_webin_cli_wrapper/main.nf
Comment thread modules/local/ena_webin_cli_wrapper/main.nf Outdated
Comment thread modules/nf-core/multiqc/main.nf Outdated
conda "${moduleDir}/environment.yml"
// TODO: version is temporarily set to 1.25.1 to avoid segfault happening in 1.32

// Container was taken from linux/arm64 instead of linux/amd64
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What does this mean?

Can you just update to the latest version in nf-core?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think their default containers are from linux/amd64
the latest gave me seqfault
Screenshot 2026-05-01 at 11 15 15

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

That is some aggresive circling hahah (I can almost see your face while doing that).

OK, I this may cause issues in linux machines then.. if this breaks I'll try to help

// Uncomment function in methodsDescriptionText to render in MultiQC report
def reference_text = [
"<li>Ewels, P., Magnusson, M., Lundin, S., & Käller, M. (2016). MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics , 32(19), 3047–3048. doi: /10.1093/bioinformatics/btw354</li>"
'<li>Richardson, L., Allen, B., Baldi, G., Beracochea, M., Bileschi, M. L., Burdett, T., ... & Finn, R. D. (2023). MGnify: the microbiome sequence data analysis resource in 2023. Nucleic acids research, 51(D1), D753-D759. doi: <a href="https://doi.org/10.1093/nar/gkac1080">10.1093/nar/gkac1080</a></li>',
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I have a script to help with these - https://gist.github.com/mberacochea/50ba897865f53767a762e240a405f6c4
just for future ref :)

@mberacochea mberacochea self-requested a review May 1, 2026 14:25
Copy link
Copy Markdown
Collaborator

@mberacochea mberacochea left a comment

Choose a reason for hiding this comment

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

Thanks @KateSakharova!

@KateSakharova KateSakharova merged commit 1c3e027 into dev May 6, 2026
20 checks passed
@KateSakharova KateSakharova deleted the feature/multiqc-citations branch May 6, 2026 13:47
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.

Include webin-cli jar into container, remove ENA_WEBIN_CLI_DOWNLOAD module

5 participants