Skip to content

Add optional KOfamScan annotation workflow - #110

Merged
Yixuan39 merged 6 commits into
devfrom
add_kofamscan
Jul 29, 2026
Merged

Yixuan39 merged 6 commits into
devfrom
add_kofamscan

Conversation

@Yixuan39

Copy link
Copy Markdown

Summary

  • Integrate optional KOfamScan-based KEGG Ortholog annotation into the pipeline.
  • Support automatic KOfam database download and extraction, plus local database overrides.
  • Add the required nf-core KOfamScan and gunzip modules, workflow wiring, parameters, output publishing, documentation, citations, and tests.
  • Update the end-to-end snapshot for the renamed InterProScan download and extraction processes.

Why

This adds KEGG Ortholog assignment as an optional functional annotation method while keeping the existing default pipeline behavior unchanged.

Validation

  • nf-test test subworkflows/local/functional_annotation/tests/main.nf.test --profile +docker --verbose — 3 tests passed.
  • End-to-end -profile test pipeline execution completed successfully and the expected snapshot process names were updated.
  • Rebased onto the latest dev branch before publishing.

Integrates optional KOfamScan-based KEGG ortholog annotation into the pipeline, including new parameters, schema entries, workflow wiring, and output publication paths. Adds nf-core `kofamscan` and `gunzip` modules (with tests) to support automatic download/extraction of KOfam profiles and KO list, alongside local database overrides. Updates docs, test configs, subworkflow tests/snapshots, and citations/auto-generated bibliography text to reflect the new functional annotation capability.
@github-actions

Copy link
Copy Markdown

Warning

Newer version of the nf-core template is available.

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

For more documentation on how to update your pipeline, please see the Synchronisation documentation.

@github-actions

github-actions Bot commented Jul 27, 2026 •

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅

Posted for pipeline commit 2ab2713

+| ✅ 231 tests passed       |+
#| ❔  11 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_exist - File is ignored: .github/workflows/linting_comment.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: .github/workflows/branch.yml
  • files_unchanged - File does not exist: .github/workflows/linting_comment.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • 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 4.0.2
  • Run at 2026-07-29 14:25:16

@github-actions

github-actions Bot commented Jul 27, 2026 •

Copy link
Copy Markdown

❌ nf-test failed with latest Nextflow version

Note

Tests with Nextflow's latest version failed but it will not cause a CI workflow failure.
Please check if the failure is expected with newer (edge-)releases of Nextflow or if it needs fixing.

  • ❌ docker | latest-everything | Shard 2/7

See the full run for details.

@vagkaratzas vagkaratzas left a comment

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.

great effort so far...preemptively left some comments throughout to keep in mind

Comment thread docs/usage.md Resolved
Comment thread workflows/proteinannotator.nf Resolved
Comment thread docs/output.md Resolved
Comment thread conf/test.config Resolved
Comment thread conf/modules.config Resolved
@Yixuan39
Yixuan39 marked this pull request as ready for review July 27, 2026 18:31
@vagkaratzas
vagkaratzas self-requested a review July 28, 2026 07:08

@vagkaratzas vagkaratzas left a comment

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.

Nice! Left 2 more final comments and should be good to merge. But just to make sure, can you reply to, and close my previous comments so I can keep track of what's been fixed or not so far? Thanks!

Comment thread nextflow.config Resolved
Comment thread nextflow_schema.json Resolved

@vagkaratzas vagkaratzas left a comment

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.

Don't forget to also update the CHANGELOG.md and add your GitHub handle in the correct format ;)

Yixuan39 added 2 commits July 29, 2026 10:21
Default `modules_testdata_base_path` to the nf-core test-datasets modules data URL in both `nextflow.config` and the schema so modules have a usable test data source out of the box.
update changelog for Yixuan39
@Yixuan39

Copy link
Copy Markdown
Author

Thanks! Just updated the CHANGELOG.md

@vagkaratzas vagkaratzas left a comment

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.

Thank you @Yixuan39 !

@Yixuan39
Yixuan39 merged commit 77302ba into dev Jul 29, 2026
23 checks passed
@Yixuan39
Yixuan39 deleted the add_kofamscan branch July 29, 2026 15:19
@Yixuan39 Yixuan39 mentioned this pull request Aug 3, 2026
@vagkaratzas vagkaratzas mentioned this pull request Sep 27, 2026
1 of 11 tasks
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