Skip to content

docs: add missing PyPOLCA citations#1076

Merged
dialvarezs merged 2 commits into
nf-core:devfrom
dialvarezs:docs/pypolca-citation
Jul 15, 2026
Merged

docs: add missing PyPOLCA citations#1076
dialvarezs merged 2 commits into
nf-core:devfrom
dialvarezs:docs/pypolca-citation

Conversation

@dialvarezs

Copy link
Copy Markdown
Member

PyPOLCA was added as an optional short-read polisher for long-read assemblies in #1048, but its citation was never added.

This PR adds PyPOLCA to the three places a tool citation belongs:

  • README.md — pipeline tool list.
  • CITATIONS.md — full reference (Bouras et al. 2024, doi: 10.1099/mgen.0.001254).
  • subworkflows/local/utils_nfcore_mag_pipeline/main.nftoolCitationText() and toolBibliographyText(), gated on params.run_pypolca, so the auto-generated methods description and bibliography include PyPOLCA when the tool is run.

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 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.
  • Check for unexpected warnings in debug mode.
  • 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).

🤖 Generated with Claude Code

PyPOLCA was added as an optional long-read assembly polisher (nf-core#1048) but was
not cited anywhere. Add it to:

- README.md pipeline tool list
- CITATIONS.md
- toolCitationText() and toolBibliographyText() in the pipeline utils
  subworkflow, gated on params.run_pypolca, so the auto-generated methods
  description and bibliography include it when the tool is run.

Citation: Bouras et al. (2024), doi: 10.1099/mgen.0.001254.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dialvarezs
dialvarezs merged commit 627ca9b into nf-core:dev Jul 15, 2026
40 of 42 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.

2 participants