VCFANNOTATE(1)

💖 NAME 💖

vcfannotate — bestie, this is the little icon that slaps BED-file annotations onto your VCF records. It's a VCF transformation, and it's giving "matchmaker but for genomic intervals" 💅

---

✨ SYNOPSIS ✨

vcfannotate options []

No cap, that's the whole shape of it — flags, then the VCF. 🦋

---

🌸 DESCRIPTION 🌸

Okay so here's the vibe: vcfannotate takes the records in your VCF file and intersects them with targets that you provide in a BED file. That's the whole main character moment. 🎀

The intersections get done on the reference sequences in the VCF file. That's the thing to remember, iykyk. 👑

And if you don't hand it a VCF filename on the command line — like, it's the last argument, that's where it goes — then the VCF gets read from stdin. So you can absolutely pipe into it, fr fr. 🫶

---

🌈 OPTIONS 🌈

the options, bestie:

• -b, --bed — use annotations provided by this BED file 🧚
• -k, --key — use this INFO field key for the annotations 🔥
• -d, --default — use this INFO field key for records without annotations 🙈

Type: transformation ✨

---

💀 EXIT VALUES 💀

• 0 — Success 🎉 like yes, we ate
• not 0 — Failure 😭 it's giving tragedy

---

🦋 SEE ALSO 🦋

• vcflib(1) — the whole squad 👑

---

💜 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. 👑

---

Sign-off time, bestie: this page comes from vcfannotate (vcflib), manual page VCFANNOTATE(1). Now go annotate something and slay 💅💖🌸