nf-core / nf-core/magmap

Populate MultiQC methods-description tool citations/bibliography

Open
#231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nextflow
Stars
12
Forks
6
Avg merge
1d 7h
Merged PRs (30d)
8

Description

Description of feature

`methodsDescriptionText()` in `subworkflows/local/utils_nfcore_magmap_pipeline/main.nf` builds the "Methods Description" section rendered into every MultiQC report (called from `workflows/magmap.nf`). However, the two lines that would actually populate it from `toolCitationText()`/`toolBibliographyText()` are commented out:

```groovy
meta["tool_citations"] = ""
meta["tool_bibliography"] = ""

// meta["tool_citations"] = toolCitationText().replaceAll(", \.", ".").replaceAll("\. \.", ".").replaceAll(", \.", ".")
// meta["tool_bibliography"] = toolBibliographyText()
```

So the methods section renders in every report, but always with blank citation/bibliography fields — this predates any specific PR, it's unmodified nf-core template boilerplate that was never activated for magmap. `toolCitationText()`/`toolBibliographyText()` themselves are also still stuck at the nf-core template's default stub (only FastQC/MultiQC), not updated for any of the tools magmap has added since (Prokka, Bakta, Samtools, trimgalore, sourmash, DuckDB, etc.).

To fix properly:

  • Fill in `toolCitationText()`/`toolBibliographyText()` with the full current tool list (matching `CITATIONS.md`, which is the actually-maintained/accurate citation list today).
  • Uncomment the two `meta["tool_citations"]`/`meta["tool_bibliography"]` lines in `methodsDescriptionText()` to wire them in.

Came up during review of #228 (v1.2.0 release PR) — flagged there as out of scope for that PR since it's pre-existing and affects every tool, not just the one added in that PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare CITATIONS.md with toolCitationText() and toolBibliographyText() in subworkflows/local/utils_nfcore_magmap_pipeline/main.nf, then inspect methodsDescriptionText() in the same file and its call from workflows/magmap.nf. Update the citation and bibliography content, enable both metadata assignments, and verify that MultiQC Methods Description sections contain the current tool references.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
bioinformatics
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.