Skip to content

Commit 7f8f964

Browse files
committed
Document indel limitations
1 parent b3a99d6 commit 7f8f964

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ The tool takes:
3737

3838
It writes annotated variants as TSV, VCF, or both.
3939

40+
> [!WARNING]
41+
> get_MNV is designed for SNV/MNV interpretation. VCF insertions and deletions
42+
> can be reported as `INDEL`, but their codon and amino-acid annotation is
43+
> limited. iVar TSV indel rows, such as `+A` or `-N`, are skipped. For detailed
44+
> indel consequence annotation, use a dedicated variant annotation tool.
45+
4046
<p align="center">
4147
<img src="images/get_mnv_aa.png" alt="MNV amino acid reclassification" width="650" />
4248
</p>
@@ -244,6 +250,7 @@ MTB_anc esxL 1341102,1341103 T,C Arg33Ser MNV No
244250
- **SNP**: single nucleotide change, one SNV per codon
245251
- **MNV**: all reads carry multiple SNVs together (Multi-Nucleotide Variant)
246252
- **SNP/MNV**: some reads carry individual SNVs, others carry the MNV combination
253+
- **INDEL**: insertion or deletion; detected/reported with limited codon and amino-acid annotation
247254

248255
## Documentation
249256

@@ -273,7 +280,7 @@ bash scripts/build_gui_bundle.sh
273280
## Limitations
274281

275282
- Designed for SNVs against a reference sequence
276-
- Insertions and deletions are detected but not fully codon-annotated
283+
- VCF insertions and deletions are detected but not fully codon-annotated; iVar TSV indel notation such as `+A` or `-N` is skipped
277284
- Multiallelic VCF records require `--split-multiallelic` or pre-splitting (`bcftools norm -m -`)
278285
- Variant contig names must match FASTA and GFF exactly
279286
- **Multiple transcripts per gene**: when using `--gff-features CDS` with a GFF file that contains multiple transcripts for the same gene, each transcript is annotated independently, producing one output line per transcript per variant. If you want a single line per variant, filter your GFF to keep only the canonical transcript before running get_MNV (e.g., using [AGAT](https://github.com/NBISweden/AGAT) `agat_sp_keep_longest_isoform.pl` or a similar tool)

0 commit comments

Comments
 (0)