Skip to content

Conversation

@vinisalazar
Copy link
Contributor

@vinisalazar vinisalazar commented Feb 3, 2026

Summary of changes:

  • Adds the rgi/bwt module
  • Based on the existing rgi/main module

This PR is a follow-up of #9585. See that for discussion.

PR checklist

Closes #XXX

  • 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

vinisalazar and others added 22 commits December 18, 2025 11:24
  - Use template from rgi/main
  - Use fastq pair instead of single fasta file
  - add fastq extensions to 'pattern'
  - Trying to pass linter
  - build KMA/BWT index in workdir instead of program executable dir
  - update test snapshot
  - Don't check temp/ directory on snapshot, is different every time
  - Update snapshot
  - provide input.reads as list
  - don't check tsv snapshot (it's different every time)
  - json files are in random order so snapshot differs every time (I think)
  - Use '--local' flag as default
  - Create topics field in meta.yml
Co-authored-by: Jim Downie <19718667+prototaxites@users.noreply.github.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
  - capture topics appropriately in meta.yml
  - Remove whitespace
  - Fix escape character in versions output
@vinisalazar vinisalazar requested a review from SPPearce February 4, 2026 00:35
vinisalazar and others added 2 commits February 5, 2026 14:39
  Code review for nf-core#9873

Co-authored-by: Simon Pearce <24893913+SPPearce@users.noreply.github.com>
Merge branch 'rgi/bwt' of github.com:vinisalazar/modules into rgi/bwt
@vinisalazar vinisalazar requested a review from SPPearce February 5, 2026 04:04
script "modules/nf-core/untar/main.nf"
process {
"""
file('https://card.mcmaster.ca/latest/data', checkIfExists: true).copyTo('card-data.tar.bz2')
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't like to use externally hosted files, as they can sometimes become missing over time. How big is this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@SPPearce thanks again for the review. The file is 4.5 Mb. What would be the best practice in this case?

Copy link
Contributor

Choose a reason for hiding this comment

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

Best practice will be to make a PR into the test-datasets repository then.
Could you make it any smaller than that?
That is quite annoyingly finnicky (and redoing how we do test-datasets has been on the to-do list for a long time now).

  1. Make the file smaller if possible, but still let the tool run.
  2. Shallow clone nf-core/test-datasets, just the modules branch.
  3. Make a PR adding the file into an appropriate place. Please don't put it in delete_me, find somewhere more appropriate.
  4. Once the PR is in, you can refer to the file like the others in the test.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @SPPearce. PR created, see below.

Co-authored-by: Simon Pearce <24893913+SPPearce@users.noreply.github.com>
vinisalazar added a commit to vinisalazar/test-datasets that referenced this pull request Feb 9, 2026
  Data for testing the rgi modules. See nf-core/modules#9873 for discussion.
vinisalazar added a commit to vinisalazar/test-datasets that referenced this pull request Feb 11, 2026
  Data for testing the rgi modules. See nf-core/modules#9873 for discussion.
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.

3 participants