Skip to content

Add metabuli/build module #8148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Add metabuli/build module #8148

wants to merge 17 commits into from

Conversation

pawelciurkaardigen
Copy link
Contributor

@pawelciurkaardigen pawelciurkaardigen commented Mar 27, 2025

PR checklist

Adds metabuli/build module that wraps metabuli build. Immediate need is having a possibility to use it in nf-core/createtaxdb to later use metabuli classify in nf-core/taxprofiler

Closes #8014

  • 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

@pawelciurkaardigen pawelciurkaardigen marked this pull request as draft April 17, 2025 08:30
@jfy133 jfy133 marked this pull request as ready for review April 17, 2025 10:09
path taxonomy_nodes, stageAs: 'taxonomy/nodes.dmp'
path taxonomy_merged, stageAs: 'taxonomy/merged.dmp'
path accession2taxid, stageAs: 'taxonomy/*'

Copy link
Member

Choose a reason for hiding this comment

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

Missing optional --cds-info file

Groovy Map containing sample information
- fasta:
type: file
description: Fasta file with input assemblies
Copy link
Member

Choose a reason for hiding this comment

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

Does it have to be a single fasta or can it be a list of FASTAs?

The docs imply to me that you can add lots of paths to fasta.txt?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes - I think there is an option to provide multiple fastas to metabuli.

description: File describing individual members of a taxonomic tree
- - taxonomy_nodes:
type: file
description: File describing parent-child relationships of a taxonomic tree
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: File describing parent-child relationships of a taxonomic tree
description: File describing parent-child relationships of a taxonomic tree in NCBI nodes.dmp format

I assume?

Comment on lines +35 to +40
path("${process.out.db[0][1]}/acc2taxid.map"),
path("${process.out.db[0][1]}/diffIdx"),
path("${process.out.db[0][1]}/info"),
file("${process.out.db[0][1]}/split").name,
path("${process.out.db[0][1]}/taxID_list"),
file("${process.out.db[0][1]}/db.parameters").name,
Copy link
Member

Choose a reason for hiding this comment

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

If these are mostly files, you can include them in the stub run as empty fils with these names

}

}
}
Copy link
Member

Choose a reason for hiding this comment

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

Missing the stub test!

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: metabuli/build
2 participants