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

Diamond/blastp updates #7381

Merged
merged 16 commits into from
Jan 30, 2025
Merged

Diamond/blastp updates #7381

merged 16 commits into from
Jan 30, 2025

Conversation

vagkaratzas
Copy link
Contributor

@vagkaratzas vagkaratzas commented Jan 28, 2025

PR checklist

Closes #7350

  • 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

@vagkaratzas vagkaratzas mentioned this pull request Jan 28, 2025
4 tasks
Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

Looks great, except for our point of disagreement! ;-)

@vagkaratzas
Copy link
Contributor Author

@erikrikarddaniel Shall we merge this version? Or wait for a verdict on -outfmt format?

@erikrikarddaniel
Copy link
Member

I think it's up to you and me, at least if nobody is actually using it. (I'm for the time being using my own in #metatdenovo.) I'll let you decide, but to reiterate my arguments for having a numerical output specification rather than a suffix:

  1. Users of the module are likely users of the tool, so they will be familiar with the different choices for --outfmt.
  2. The output format is both a format, e.g. tsv, and content, and at least two output formats are actually the same format, i.e. both blast and taxonomy are tsv.
  3. If the param is called ext or similar a user of the module might (I did) guess that one can specify compression by adding a .gz suffix to the format.
  4. IMO, it's more explicit to ask for the tool's param value and get the module to return a file with a suffix it chose, than the reverse.
  5. I know everything is (should be) specified in the documentation -- but who reads that?
  6. I suppose there are other modules with similar problems and I don't know if there's a general recommendation.

@vagkaratzas
Copy link
Contributor Author

I think it's up to you and me, at least if nobody is actually using it. (I'm for the time being using my own in #metatdenovo.) I'll let you decide, but to reiterate my arguments for having a numerical output specification rather than a suffix:

  1. Users of the module are likely users of the tool, so they will be familiar with the different choices for --outfmt.
  2. The output format is both a format, e.g. tsv, and content, and at least two output formats are actually the same format, i.e. both blast and taxonomy are tsv.
  3. If the param is called ext or similar a user of the module might (I did) guess that one can specify compression by adding a .gz suffix to the format.
  4. IMO, it's more explicit to ask for the tool's param value and get the module to return a file with a suffix it chose, than the reverse.
  5. I know everything is (should be) specified in the documentation -- but who reads that?
  6. I suppose there are other modules with similar problems and I don't know if there's a general recommendation.

Ok, I'm sold. Have a look an feel free to merge if tests pass and you are happy with the changes!

Copy link
Member

@erikrikarddaniel erikrikarddaniel left a comment

Choose a reason for hiding this comment

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

OK, I made two suggestions. I'll accept them and merge.

modules/nf-core/diamond/blastp/main.nf Outdated Show resolved Hide resolved
modules/nf-core/diamond/blastp/main.nf Outdated Show resolved Hide resolved
@erikrikarddaniel
Copy link
Member

@vagkaratzas I'm stuck with failing tests due to the runner problems recently. I'll just wait until I need to merge upstream again, and hope they pass then. (I don't know of another way of triggering them... :-S)

@vagkaratzas vagkaratzas added this pull request to the merge queue Jan 30, 2025
Merged via the queue into master with commit e65e04b Jan 30, 2025
33 checks passed
@vagkaratzas vagkaratzas deleted the diamond/blastp branch January 30, 2025 17:31
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.

update module: diamond/blastp
2 participants