BFST(1)

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

✨ bFst β€” the manual page, bestie edition ✨

okay so you found bFst(1) and you're like "what is this" β€” don't worry, I got you. this is the whole page, every single crumb of it, just with ✨personality✨. buckle up. πŸŽ€


🌸 NAME 🌸

bFst β€” that's it, that's the name. short, sweet, iconic, no notes. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

bFst –target 0,1,2,3,4,5,6,7 –background 11,12,13,16,17,19,22 –file
my.vcf –deltaaf 0.1

like… that's the vibe. you point it at a VCF, you tell it who's who, it does math. 🧚


πŸ’– DESCRIPTION πŸ’–

so bFst is a Bayesian approach to Fst. and the important part, the part that makes it eat: bFst accounts for genotype uncertainty in the model using genotype likelihoods. it's not out here pretending genotypes are all perfectly known, okay, it's being honest about the uncertainty and it's thriving. 😌

if you want the full lore, the detailed description lives in: `A Bayesian approach to inferring population structure from dominant markers' by Holsinger et al., Molecular Ecology Vol 11, issue 7, 2002. and here's the tea β€” the likelihood function has been modified to use genotype likelihoods provided by variant callers. periodt.

so there are five free parameters getting estimated in this model, and yes I'm listing all five because every one of them matters:

  1. each subpopulation's allele frequency
  2. each subpopulation's Fis (that's the fixation index, within each subpopulation)
  3. a free parameter for the total population's allele frequency
  4. Fst

(okay technically that reads as five free parameters total across "each subpopulation's allele frequency and Fis" + total pop allele freq + Fst β€” that's exactly what the page says and I'm not changing a single digit, bestie. 🫢)


πŸŽ€ OPTIONS πŸŽ€

πŸ’… Output

11 columns, count them, no more no less:

  1. Seqid
  2. Position
  3. Observed allele frequency in target.
  4. Estimated allele frequency in target.
  5. Observed allele frequency in background.
  6. Estimated allele frequency in background.
  7. Observed allele frequency combined.
  8. Estimated allele frequency in combined.
  9. ML estimate of Fst (mean)
  10. Lower bound of the 95% credible interval
  11. Upper bound of the 95% credible interval

πŸ‘‘ The required ones (yes, required, don't skip them)

  • -t, target β€” a zero bases comma separated list of target individuals corrisponding to VCF columns. (that's "corrisponding", spelled exactly how the page spells it, we don't edit here 😭)
  • -b, background β€” a zero bases comma separated list of background individuals corrisponding to VCF columns.
  • -f, file a β€” a proper formatted VCF file. and listen, this one's a big deal:
the FORMAT field MUST contain "PL" β€” like, MUST must. no PL, no party. πŸ’€
  • -d, deltaaf β€” skip sites were the difference in allele frequency is less than deltaaf. (again, "were", exactly as written, I am not the one fixing typos in a manpage, I am simply the one delivering them to you with love 🌸)

⭐ Type

statistics β€” it's giving statistics. it's literally classified as statistics. slay.


🌈 EXIT VALUES 🌈

  • 0 β€” Success. the happy ending. we love to see it. πŸ₯³
  • not 0 β€” Failure. something went sideways, bestie. 😭

πŸ“ SEE ALSO πŸ“

  • vcflib(1) β€” go read that one too, it's the family. 🫢

πŸ’œ OTHER πŸ’œ

πŸ“œ LICENSE

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

(legal text stays legal text, I'm just handing it to you in a cute font. πŸ’–)

πŸ–‹οΈ AUTHORS

Erik Garrison and vcflib contributors. absolute main characters, no cap. πŸ‘‘


and that's the whole page, bestie!! this beauty is from bFst (vcflib) β€” the version/source line at the bottom β€” so go forth, pass your -t, -b, -f and -d, and make some credible intervals. πŸ¦‹βœ¨πŸ’…

πŸ“¦ where this page comes from