docs(modkit/pileup): clarify BAM index, BED format, and --cpg requirements#10341
docs(modkit/pileup): clarify BAM index, BED format, and --cpg requirements#10341sahuno wants to merge 1 commit intonf-core:masterfrom
Conversation
…ments in meta.yml
- Update BAI index pattern to *.{bai,csi} since modkit supports CSI indices via htslib
- Document that --include-bed requires BED3 or BED6 format (BED4 is rejected)
- Note that --cpg requires --modified-bases to be passed via ext.args
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Please post on the nf-core slack #github-invitations channel, to be added to the organisation so the tests runs. |
SPPearce
left a comment
There was a problem hiding this comment.
Is it worth adding a check in the module code itself for the --modified-bases or the number of columns in the bed file? Rather than just the meta.yml
For For better error reporting on the number of columns in the bed file, I feel like this is something that should be adressed in an issue at https://github.com/nanoporetech/modkit rather than checking it in the nf-core module. The tool is actively developed and maintained. |
Summary
*.baito*.{bai,csi}— modkit supports CSI indices via htslib, and ONT BAMs commonly use CSI--include-bedrequires strict BED3 or BED6 format — BED4 (e.g. UCSC CpG island downloads) is silently rejected, leading to a confusing "zero valid positions parsed" error--cpgrequires--modified-basesto also be passed viaext.args, otherwise modkit errors with "required arguments not provided"All three issues were discovered while testing the module with real ONT methylation data (mm10, dorado basecalled BAMs with 5mCG_5hmCG modifications).
Changes
Documentation-only changes to
meta.yml. No code changes tomain.nf.Test plan
--cpg --modified-bases 5mCproduces correct bedMethyl output🤖 Generated with Claude Code