Skip to content

New module: modkit/validate#11284

Open
sahuno wants to merge 1 commit intonf-core:masterfrom
sahuno:add-modkit-validate
Open

New module: modkit/validate#11284
sahuno wants to merge 1 commit intonf-core:masterfrom
sahuno:add-modkit-validate

Conversation

@sahuno
Copy link
Copy Markdown

@sahuno sahuno commented Apr 24, 2026

PR checklist

  • This comment contains a description of changes (with reason).
  • Stub test added (see note on real test below).
  • New tool follows module conventions.
  • Versions broadcast via `topic: versions`.
  • Naming/parameter/I-O conventions followed.
  • Resource label set (`process_medium`).
  • BioConda + BioContainers used.
  • `nf-core modules lint modkit/validate` — 46/0/0.
  • `nf-test test --profile conda` — 1/1 passed (stub).

Summary

Adds a new nf-core module wrapping `modkit validate`, which benchmarks base-modification calls in one or more mod-BAMs against paired ground-truth BED files and emits a tab-separated summary of correct / incorrect / filtered calls per class.

The module accepts paired lists of BAMs and truth-BEDs (1:1 by list index) and forwards each pair as a repeated `--bam-and-bed ` argument to modkit.

Why

`modkit validate` is the only canonical way to benchmark ONT methylation-calling accuracy against ground truth and is not currently in nf-core/modules. It's used to compare modkit pileup thresholds, evaluate basecaller-model upgrades, and assess spike-in control performance.

Test data — stub only

`modkit validate` requires a BAM paired with a ground-truth BED whose name column is a single-letter modified-base code (`m`, `h`, ...) or `-` for a canonical reference position. The public nf-core test-datasets modules branch doesn't ship such a BED. Committed test is stub-only with a placeholder `genome.bed` for staging; the meta.yml documents the truth-BED contract for downstream users. Happy to contribute a small curated truth BED to nf-core/test-datasets in a follow-up.

🤖 Generated with Claude Code

Add new nf-core module wrapping `modkit validate`, which benchmarks
modified-base calls in one or more mod-BAMs against paired ground-truth
BED files and emits a tab-separated summary of correct / incorrect /
filtered calls per class.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sahuno sahuno force-pushed the add-modkit-validate branch from 0a6b8eb to c8ad076 Compare April 24, 2026 02:44
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.

1 participant