VCFREMAP(1)

πŸ“¦
version 1.0.12 Β· 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

okay bestie, say hi to vcfremap β€” that's the name, that's the whole vibe. it's a VCF transformation girlie and she's about to remap ur variants. periodt. πŸ¦‹


✨ SYNOPSIS ✨

vcfremap options []

🌸 DESCRIPTION 🌸

so here's the tea β˜• β€” for every single alternate allele, vcfremap tries to realign it against the reference, but with a lowered gap open penalty (yes, she's being generous with the gaps, it's giving main character energy).

if that realignment is actually possible? she adjusts the cigar and the reference/alternate alleles accordingly. slay. πŸ’…

and like, the whole point is to observe how different alignment parameters β€” including the context-dependent ones AND the entropy-dependent ones β€” influence how variants get classified and interpreted. lowkey a science experiment, highkey iconic. πŸ”₯


πŸŽ€ OPTIONS πŸŽ€

here's the full menu, no skips, no shortcuts, we love an exhaustive list:

  • -w, --ref-window-size N β€” align using this many bases flanking each side of the reference allele. window seat, both sides. 🌈
  • -s, --alt-window-size N β€” align using this many flanking bases from the reference around each alternate allele. so like, the alt's personal little entourage of context bases. ✨
  • -r, --reference FILE β€” the FASTA reference file. required if you're using -i and -u. no reference, no service. πŸ™ˆ
  • -m, --match-score N β€” match score for the SW algorithm. when things match, they get points. good for them. πŸ’–
  • -x, --mismatch-score N β€” mismatch score for the SW algorithm. the penalty for not matching. oop. πŸ’€
  • -o, --gap-open-penalty N β€” gap open penalty for the SW algorithm. how much it costs to start a gap. think of it as the cover charge at the gap club. πŸŽ€
  • -e, --gap-extend-penalty N β€” gap extension penalty for the SW algorithm. the cost of keeping that gap going. 🧚
  • -z, --entropy-gap-open β€” use entropy scaling for the gap open penalty. entropy said "let me handle this one". πŸŒ€
  • -R, --repeat-gap-extend N β€” penalize non-repeat-unit gaps in repeat sequence. repeat sequences get special treatment, and non-repeat-unit gaps get called out. not me being petty to gaps. 😭
  • -a, --adjust-vcf TAG β€” supply a new cigar as TAG in the output VCF. you pick the tag name, she does the rest. πŸ‘‘

πŸ’€ EXIT VALUES πŸ’€

  • 0 β€” Success. we ate. πŸ”₯
  • not 0 β€” Failure. it's giving tragedy. 😭

🫢 SEE ALSO 🫢


⭐ OTHER ⭐

πŸ“œ LICENSE πŸ“œ

Copyright 2011-2024 (C) Erik Garrison and vcflib contributors. MIT licensed. Copyright 2020-2024 (C) Pjotr Prins.

πŸ‘‘ AUTHORS πŸ‘‘

Erik Garrison and vcflib contributors.


and that's the whole page bestie πŸŽ€ β€” brought to u by vcfremap (vcflib), living under the umbrella of vcfremap (VCF transformation), with all the love and none of the timestamps. go remap something iconic βœ¨πŸ’–πŸ¦‹

πŸ“¦ where this page comes from