Skip to content

Conversation

@Ales-ibt
Copy link
Contributor

@Ales-ibt Ales-ibt commented Jan 9, 2026

This PR contains the addition of the local-cd-search tool module (annotate and download). Please note that the tool version is not displayed in v0.3.0. I had opened an issue requesting the functionality to the original author. At the moment, the version is hardcoded.

Also, local-cd-search image is not available in Seqera Containers yet and Galaxy Depot doesn't have it either, so we are relying on biocontainers.

Thank you for reviewing!

PR checklist

Closes #9574

  • 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 module conventions in the contribution docs
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Review for just download mostly what we talked about on Slack and then a few other minor things

Ales-ibt and others added 16 commits January 9, 2026 13:28
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
@Ales-ibt Ales-ibt requested review from SPPearce and jfy133 January 9, 2026 14:39
Copy link
Contributor

@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.

Nice! Couple of things and it should be getting there

'biocontainers/local-cd-search:0.3.0--pyhdfd78af_0' }"

input:
val databases
Copy link
Contributor

Choose a reason for hiding this comment

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

If you ask me, I would add a meta since it's the only input, but don't really have a strong opinion for or against it. mmseqs_databases module is also not using any meta for val database which is also a single input.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Meta should be the database name, right? The problem with meta here is that the input is a list that can contain multiple databases. It sound to me that handling a list on meta will be problematic. The option would be to join the list into a string, but that would be hard to read

process {
"""
input[0] = [ [id:'test'], file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/proteome.fasta', checkIfExists: true) ]
input[1] = LOCALCDSEARCH_DOWNLOAD.out.db
Copy link
Contributor

Choose a reason for hiding this comment

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

Just curious, if you had downloaded multiple dbs, would this still be the same? Or do you need to select one or more of the downloaded dbs somehow?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The downloader tool creates the databases directory structure and the annotator detects all the available databases in the given directory. Then the tool runs the annotation versus ALL the detected databases. There's no way to select which database to use when multiple databases exists

@Ales-ibt Ales-ibt requested a review from vagkaratzas January 12, 2026 14:48
Copy link
Contributor

@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.

Two last comments and I think it's good to go

@Ales-ibt Ales-ibt requested a review from vagkaratzas January 12, 2026 16:02
Copy link
Contributor

@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.

Looks good IMO! Can always patch-update later if something's off!

@Ales-ibt Ales-ibt added this pull request to the merge queue Jan 13, 2026
Merged via the queue into master with commit 04dcc4d Jan 13, 2026
52 checks passed
@Ales-ibt Ales-ibt deleted the feature/localcdsearch branch January 13, 2026 15:43
vagkaratzas added a commit that referenced this pull request Jan 14, 2026
* local-cd-search annotate and download modules

* Fixing lint

* Update localcdsearch tool metadata in meta.yml

* Fix container URL selection logic in main.nf

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Update modules/nf-core/localcdsearch/annotate/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Singularity container added

* edamontology added

* Updating test for one input only

* Updating snap

* Updating test for db downloding

* Update version handling in main.nf

* Update version expression in meta.yml

* Refactor version handling in main.nf

Updated version information to use a variable for better maintainability.

* Update version retrieval expression in meta.yml

* Add version information to stub

Added version information for the tool in the main.nf file.

* Add version information to stub

Added version information to the main.nf file.

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: Evangelos Karatzas <32259775+vagkaratzas@users.noreply.github.com>

* Refactor assertions to include process success check

* Refactor assertions for process success in tests

* Update container URL for local-cd-search

* Remove redundant success assertion in tests

---------

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: Evangelos Karatzas <32259775+vagkaratzas@users.noreply.github.com>
mmYeung pushed a commit to mmYeung/modules that referenced this pull request Jan 28, 2026
* local-cd-search annotate and download modules

* Fixing lint

* Update localcdsearch tool metadata in meta.yml

* Fix container URL selection logic in main.nf

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Fix container URL for local-cd-search

* Update modules/nf-core/localcdsearch/annotate/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Singularity container added

* edamontology added

* Updating test for one input only

* Updating snap

* Updating test for db downloding

* Update version handling in main.nf

* Update version expression in meta.yml

* Refactor version handling in main.nf

Updated version information to use a variable for better maintainability.

* Update version retrieval expression in meta.yml

* Add version information to stub

Added version information for the tool in the main.nf file.

* Add version information to stub

Added version information to the main.nf file.

* Update modules/nf-core/localcdsearch/download/meta.yml

Co-authored-by: Evangelos Karatzas <32259775+vagkaratzas@users.noreply.github.com>

* Refactor assertions to include process success check

* Refactor assertions for process success in tests

* Update container URL for local-cd-search

* Remove redundant success assertion in tests

---------

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: Evangelos Karatzas <32259775+vagkaratzas@users.noreply.github.com>
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.

new module: blast/rpsblast -> local-cd-search

5 participants