Skip to content

Add kivvi module - #13110

Open
sofiademmou wants to merge 5 commits into
masterfrom
add-kivvi
Open

sofiademmou wants to merge 5 commits into
masterfrom
add-kivvi

Conversation

@sofiademmou

@sofiademmou sofiademmou commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

PR checklist

This PR adds a new nf-core module for kivvi.
Closes #13089

  • 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

@github-actions github-actions Bot added the size/m label Oct 8, 2026
@sofiademmou
sofiademmou marked this pull request as ready for review October 9, 2026 09:29
@sofiademmou sofiademmou added the new module Adding a new module label Oct 9, 2026

@erikrikarddaniel erikrikarddaniel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 main branch of the tool's own repository; they should come from nf-core/test-datasets.
  • The JSON's supporting_reads lists change order between runs, so the JSON (and the SVG) need unstableKeys, 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.

Comment thread modules/nf-core/kivvi/main.nf Outdated
Comment thread modules/nf-core/kivvi/main.nf Outdated
Comment on lines +23 to +24
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),

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

Comment thread modules/nf-core/kivvi/tests/main.nf.test
Comment thread modules/nf-core/kivvi/tests/main.nf.test Outdated
sofiademmou and others added 3 commits October 9, 2026 13:11
Co-authored-by: Daniel Lundin <erik.rikard.daniel@gmail.com>
Co-authored-by: Daniel Lundin <erik.rikard.daniel@gmail.com>
@github-actions github-actions Bot added size/l and removed size/m labels Oct 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new module Adding a new module size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: kivvi

2 participants