modules icon indicating copy to clipboard operation
modules copied to clipboard

Mixcr

Open derrik-gratz opened this issue 6 months ago • 0 comments

PR checklist

Init basic MiXCR module for TCR/BCR processing. While there is a lot more functionality in MiXCR that could be added for larger workflows (e.g. airrflow), for now this just includes MiXCR's catch-all wrapper analyze that will run the full tool. The CI framework set up here should allow easier addition & maintenance of additional MiXCR processes too, as the github secret workflow is set up.

  • [x] This comment contains a description of changes (with reason).
  • [x] If you've fixed a bug or added code that should be tested, add tests!
  • [x] If you've added a new tool - have you followed the module conventions in the contribution docs
  • [x] If necessary, include test data in your PR.
  • [x] Remove all TODO statements.
  • [x] Emit the versions.yml file.
  • [x] Follow the naming conventions.
  • [x] Follow the parameters requirements.
  • [x] Follow the input/output options guidelines.
  • [x] Add a resource label
  • [x] ~Use BioConda and BioContainers if possible to fulfil software requirements.~
    • MiXCR does not want their software hosted on bioconda for licensing concerns
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • [x] nf-core modules test <MODULE> --profile docker
      • [x] nf-core modules test <MODULE> --profile singularity
      • [x] nf-core modules test <MODULE> --profile conda

derrik-gratz avatar Jun 17 '25 19:06 derrik-gratz