Skip to content
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

new module: hmmer/hmmpress #7514

Merged
merged 9 commits into from
Feb 25, 2025
Merged

new module: hmmer/hmmpress #7514

merged 9 commits into from
Feb 25, 2025

Conversation

ochkalova
Copy link
Contributor

@ochkalova ochkalova commented Feb 25, 2025

PR checklist

  • This comment contains a description of changes (with reason).
  • 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

PR adds new tool hmmpress from HMMER package. It indexes and compressed hmm flatfiles to prepare input database for hmmscan.

Anticipating possible quesstions about pattern of the input file in meta.yml
The input file is supposed to be *.hmm, but file can have no extension for better looking output names
Even in the manual author suggests using input filename without extension:

Step 2: compress and index the flatfile with hmmpress
hmmscan has to read a lot of profiles in a hurry, and HMMER’s text
flatfiles are bulky. To accelerate this, hmmscan depends on binary compression and indexing of the flatfiles. First you compress and index
your profile database with the hmmpress program:

% hmmpress minifam

This will produce:

Working... done.
Pressed and indexed 3 HMMs (3 names and 2 accessions).
Models pressed into binary file: minifam.h3m
SSI index for binary model file: minifam.h3i
Profiles (MSV part) pressed into: minifam.h3f
Profiles (remainder) pressed into: minifam.h3p

and you’ll see these four new binary files in the directory.

Otherwise, output files will be minifam.hmm.h3m and etc

@ochkalova ochkalova self-assigned this Feb 25, 2025
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.

Almost there! Just a couple small suggestions and it's good to go!

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.

LGTM!

@vagkaratzas vagkaratzas added this pull request to the merge queue Feb 25, 2025
Merged via the queue into master with commit 26b0fc1 Feb 25, 2025
44 checks passed
@vagkaratzas vagkaratzas deleted the hmmer_hmmpress branch February 25, 2025 14:54
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