Skip to content

[WIP]I have added orthofinder 3 as a separate module#10338

Open
chriswyatt1 wants to merge 4 commits intonf-core:masterfrom
chriswyatt1:orthofinder3
Open

[WIP]I have added orthofinder 3 as a separate module#10338
chriswyatt1 wants to merge 4 commits intonf-core:masterfrom
chriswyatt1:orthofinder3

Conversation

@chriswyatt1
Copy link
Contributor

@chriswyatt1 chriswyatt1 commented Mar 5, 2026

PR checklist

Closes #10337 to be completed

  • 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.
  • 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
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

@chriswyatt1 chriswyatt1 added the WIP Work in progress label Mar 5, 2026
@chriswyatt1 chriswyatt1 self-assigned this Mar 5, 2026
@chriswyatt1 chriswyatt1 moved this to In progress in Hackathon March 2026 Mar 5, 2026
@chriswyatt1
Copy link
Contributor Author

We need to make sure the output snapshot doesnt just take versions

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.

Why is this a separate module, rather than just updating the current orthofinder module?

@chriswyatt1
Copy link
Contributor Author

People are still actively using the older module. The version 3 is a beta version, so I didn't want to remove the version 2. Is there a better way to solve this issue?

@chriswyatt1
Copy link
Contributor Author

This is the tool: https://github.com/davidemms/OrthoFinder

@SPPearce
Copy link
Contributor

SPPearce commented Mar 6, 2026

Looks like the tool is now at https://github.com/OrthoFinder/OrthoFinder
Has the input/output and arguments changed a lot between the two?

@SPPearce
Copy link
Contributor

SPPearce commented Mar 6, 2026

Nothing in the release notes or README makes me think that the tool is radically different from the previous version.

@chriswyatt1
Copy link
Contributor Author

You are right, it is still doing the same tasks (mostly), even if it is a big overhaul:

--assign flags to add assign new species to existing runs of orthofinder (using --core). It may be the case that this behaviour warrants its own submodule orthofinder/assign as it is quite different ins/outs. But I have not done that in this module, it just works with the standard input of a protein fasta file store.

I just worry that several users wanted the older version, so should I just tell them to convert the existing 2.5.5 version to a local module, or start adapting to the newer version 3.1.3. I guess thats cleaner than having two modules with separate versions.

Thanks for helping with this, as I was quite unsure which route to take!

@SPPearce
Copy link
Contributor

SPPearce commented Mar 9, 2026

If people want to keep the older version, they don't have to update.
I agree, it sounds like there should be a separate submodule for the other mode, better that than trying to incorporate multiple distinct modes into one module.

@chriswyatt1
Copy link
Contributor Author

OK, great. I will change the PR to update the module on nf-core to v3 as default. Not two versions.
Then they still have the old version privately

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

Labels

WIP Work in progress

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

new module: orthofinder3

2 participants