Skip to content

Add metagroot domain annot#90

Merged
vagkaratzas merged 15 commits into
devfrom
add-metagroot-domain-annot
Mar 31, 2026
Merged

Add metagroot domain annot#90
vagkaratzas merged 15 commits into
devfrom
add-metagroot-domain-annot

Conversation

@angelphanth
Copy link
Copy Markdown
Contributor

@angelphanth angelphanth commented Mar 13, 2026

PR checklist

Closes #80

This pull request adds support for annotating protein domains using the MetagRoot (MROOT) database to the pipeline. It introduces new configuration parameters, updates documentation and citations, and adds a new wget module for downloading external resources. The most important changes are grouped below.

MetagRoot (MROOT) integration:

  • Added new parameters (skip_mroot, mroot_db, mroot_latest_link) to support domain annotation with the MetagRoot database in nextflow.config, test.config, and nextflow_schema.json. These allow users to enable/disable MROOT annotation, specify a local database, or download the latest version. [1] [2] [3]
  • Updated main.nf and conf/modules.config to include new processes for downloading and searching the MROOT database, mirroring the existing setup for other domain databases. [1] [2] [3]

New wget module:

  • Added a new reusable wget module (modules/nf-core/wget/) with its process definition, environment, metadata, and comprehensive tests and snapshots. This module is used for downloading external resources such as the MROOT database. [1] [2] [3] [4] [5] [6] [7]

Documentation and citation updates:

  • Updated the Zenodo DOI in the README and added a proper citation section for nf-core/proteinannotator. [1] [2]

These changes collectively enable and document support for the MetagRoot database in the protein annotation pipeline, improve reproducibility, and enhance the pipeline's flexibility for users.

  • 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/proteinannotator branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (e.g. nf-test test */local --profile=~test,docker for all new local tests).
  • Check for unexpected warnings in debug mode (nf-test test */local --profile=~test,docker,debug).
  • 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).

@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 Mar 30, 2026

nf-core pipelines lint overall result: Passed ✅

Posted for pipeline commit 972f149

+| ✅ 221 tests passed       |+
#| ❔   7 tests were ignored |#
Details

❔ Tests ignored:

  • files_exist - File is ignored: .github/workflows/ci.yml
  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/nf-core-proteinannotator_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-proteinannotator_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-proteinannotator_logo_dark.png

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-03-31 11:04:51

@angelphanth angelphanth marked this pull request as ready for review March 30, 2026 17:02
@angelphanth angelphanth requested a review from vagkaratzas March 30, 2026 17:02
Comment thread main.nf
params.skip_nmpfams,
params.nmpfams_db,
params.nmpfams_latest_link,
params.metagroot_db,
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 think you forgot to pass the skip flag and the sequence of passed parameters got messed up a bit :D
See end-to-end snapshot failure -probably because of this lil buddy not being here

@vagkaratzas vagkaratzas self-requested a review March 31, 2026 10:58
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.

LGTM! :D

@vagkaratzas vagkaratzas merged commit 96885a2 into dev Mar 31, 2026
21 checks passed
@vagkaratzas vagkaratzas deleted the add-metagroot-domain-annot branch March 31, 2026 11:16
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.

3 participants