Skip to content

Conversation

@khersameesh24
Copy link
Contributor

@khersameesh24 khersameesh24 commented Nov 28, 2025

Added new modules for TD2 - longorfs and predict

Closes #9470

  • [️✅] 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
  • [️✅] If necessary, include test data in your PR.
  • [️✅] Remove all TODO statements.
  • [✅] Emit the versions.yml file.
  • [️✅] 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
    • For subworkflows:
      • [❌] nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • [❌] nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • [❌] nf-core subworkflows test <SUBWORKFLOW> --profile conda

@khersameesh24 khersameesh24 linked an issue Nov 28, 2025 that may be closed by this pull request
4 tasks
@khersameesh24 khersameesh24 self-assigned this Nov 28, 2025
@khersameesh24 khersameesh24 added the new module Adding a new module label Nov 28, 2025
Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

Please look at swapping to using a topic channel to emit the version:
https://nf-co.re/blog/2025/version_topics

"""
TD2.LongOrfs \\
-t ${fasta} \\
-O ${prefix} \\
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we just make the files directly in this folder, rather than a subfolder?

tuple val(meta), path(fasta)

output:
tuple val(meta), path("${prefix}/longest_orfs.{cds,gff3,pep}"), emit: orfs
Copy link
Contributor

Choose a reason for hiding this comment

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

We generally make one output channel per file, rather than multiple in one, unless there is a good reason otherwise.


cat <<-END_VERSIONS > versions.yml
"${task.process}":
td2: \$(td2 v1.0.6)
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be getting the version from the tool.
If the tool doesn't give a version, it should be set as a separate string with warnings to ensure people remember to change if they change the version.
https://github.com/search?q=repo%3Anf-core%2Fmodules+%22not+provided+by+tool+on+CLI%22

},
{
"TD2_PREDICT": {
"td2": null
Copy link
Contributor

Choose a reason for hiding this comment

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

This shouldn't be null.

"community.wave.seqera.io/library/td2:1.0.6--ea3e5ac09443b677"}"

input:
tuple val(meta), path(fasta), path(orfs_dir, stageAs: 'orfs')
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, so this tool requires all three files in one directory? Then I can see a reason to emit them as one channel above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new module Adding a new module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: TD2

3 participants