VCFRANDOMSAMPLE(1)

📦
version 1.0.12 · 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 VCFRANDOMSAMPLE(1) 💖

okay bestie, so this is vcfrandomsample from the vcfrandomsample (VCF statistics) manual — yes the manual name is literally the same as the command, iconic of it tbh. grab a strawberry 🍓 and let's go.

✨ NAME ✨

vcfrandomsample — the lil tool that picks random sites out of your VCF like it's pulling names out of a hat, but make it science 💅

🌸 SYNOPSIS 🌸

vcfrandomsample options []

that's it. that's the whole vibe. no cap.

🦋 DESCRIPTION 🦋

So the tea is: this thing randomly samples sites from an input VCF file, and the VCF can totally just be handed to it through stdin — no drama, no extra file, she'll take it however you give it to you.

Here's the main character part tho: you can scale the sampling probability by whatever field you name in KEY. and like, why would you even want that? because it lets you get uniform sampling across allele frequencies, for instance. so instead of your rare variants getting absolutely ignored, they get their moment. we love an equitable queen. 👑

💅 OPTIONS 💅

the whole menu, no skipping, every single one:

  • -r, --rate RATE — the base sampling probability per locus. your starting odds, your baseline, your default energy ✨
  • -s, --scale-by KEY — scale the sampling likelihood by this Float info field. hand her a KEY and she'll weight accordingly 🎀
  • -p, --random-seed N — use this random seed, like, N. (by default she reads from /dev/random — chaotic but valid)
  • -q, --pseudorandom-seed — use a pseudorandom seed instead. (again, by default it's read from /dev/random)
bestie reminder: -p and -q both say the default is reading from /dev/random, so if you don't pass either, that's the vibe you're getting. 🫶

🔥 EXIT VALUES 🔥

  • 0 — Success! she ate. 🎉
  • not 0 — Failure. not me crying 😭 something went wrong.

🌈 SEE ALSO 🌈

  • vcflib(1) — go say hi to the family, iykyk

👑 OTHER 👑

📜 LICENSE 📜

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

periodt. legally iconic, protect the open source girlies 💜

🧚 AUTHORS 🧚

Erik Garrison and vcflib contributors.

and that's the whole page, bestie!! this was vcfrandomsample (vcflib) — footer says source/version vcflib, and shoutout to the manual itself for being the moment. mwah 💋 go sample something cute 🦋🌸

📦 where this page comes from