Repository navigation
Add kivvi module - #13110
Add kivvi module#13110sofiademmou wants to merge 5 commits into
Conversation
erikrikarddaniel
left a comment
There was a problem hiding this comment.
Reviewed with Claude Code.
Thanks for adding kivvi!
I ran v1.1.0 from the module's container on the two example bamlets (twice for kiv2, to check which outputs are stable).
The main thing: the module only emits the realigned BAM, but kivvi's results are the JSON report (copy number, alleles, variants) and the VCF; it also writes an SVG and a BAM index.
Suggestions inline for main.nf and the stub; meta.yml needs the same outputs.
Tests:
- The real tests read their bamlets from the
mainbranch of the tool's own repository; they should come from nf-core/test-datasets. - The JSON's
supporting_readslists change order between runs, so the JSON (and the SVG) needunstableKeys, and the copy number call itself is worth asserting (values inline). - The "set outdir" stub test passes
--out ./, which the module already sets, so it can't fail on its own.
Minor: the PR checklist is still all unticked.
| file('https://raw.githubusercontent.com/PacificBiosciences/kivvi/main/example/HG03453_d4z4_extract.bam', checkIfExists: true), | ||
| file('https://raw.githubusercontent.com/PacificBiosciences/kivvi/main/example/HG03453_d4z4_extract.bam.bai', checkIfExists: true), |
There was a problem hiding this comment.
Test data should come from nf-core/test-datasets (params.modules_testdata_base_path), like the stub tests below. These bamlets are on the main branch of the tool's own repository, which can change or move under the test.
Both are small (40 and 7 MB), so they could be added to test-datasets as they are.
Co-authored-by: Daniel Lundin <erik.rikard.daniel@gmail.com>
Co-authored-by: Daniel Lundin <erik.rikard.daniel@gmail.com>
PR checklist
This PR adds a new nf-core module for kivvi.
Closes #13089
topic: versions- See version_topicslabelnf-core modules test <MODULE> --profile dockernf-core modules test <MODULE> --profile singularitynf-core modules test <MODULE> --profile condanf-core subworkflows test <SUBWORKFLOW> --profile dockernf-core subworkflows test <SUBWORKFLOW> --profile singularitynf-core subworkflows test <SUBWORKFLOW> --profile conda