SEQUENCEDIVERSITY(1)

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

πŸ’– NAME πŸ’–

okay so bestie, this is sequenceDiversity β€” yes, the manual name is literally just that, no extra crumbs. it's giving lowercase-camelCase icon behaviour and we're obsessed. ✨


🌸 SYNOPSIS 🌸

sequenceDiversity –target 0,1,2,3,4,5,6,7 –file my.vcf

that's it. that's the whole vibe. you point it at some targets and a VCF and it goes to work πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so sequenceDiversity is the program that calculates two of the most popular metrics for haplotype diversity, and no we're not gatekeeping them: they're pi and extended haplotype homozygosity (aka eHH). πŸ”₯

Pi gets computed using the Nei and Li 1979 formulation β€” that's the receipts, periodt.

eHH is honestly just a really convenient way to think about haplotype diversity, like a little vibe check for your window:

  • when eHH = 0, every haplotype in the window is unique β€” all main characters, no copies 🌈
  • when eHH = 1, every haplotype in the window is identical β€” matching outfits, head to toe πŸ‘‘

✨ OPTIONS ✨

πŸ“Š Output : 5 columns

okay so when it prints, it's printing 5 columns, in this exact order, no notes:

  1. seqid
  2. start of window
  3. end of window
  4. pi
  5. eHH

πŸŽ€ the actual flags

  • t, target β€” required 🫢 argument: a zero base comma separated list of target individuals corresponding to VCF columns
  • f, file β€” required πŸ’– argument: a properly formatted phased VCF file
  • y, type β€” required ⭐ argument: type of genotype likelihood, so one of PL, GL or GP
  • a, af β€” optional 🌸 sites less than af are filtered out; default is 0
  • r, region β€” optional 🧚 argument: a tabix compliant region, so either "seqid:0-100" or just "seqid"
  • w, window β€” optional πŸ’œ argument: the number of SNPs per window; default is 20

Type: statistics β€” that's the category tag, iykyk πŸ“Œ


πŸ’€ EXIT VALUES πŸ’€

  • 0 β€” Success ✨ slay, it worked, we love that for you
  • not 0 β€” Failure 😭 something went sideways, go check your inputs bestie

🌈 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 you by sequenceDiversity from the vcflib family, catalogued under sequenceDiversity (VCF statistics), and yes the footer literally just says sequenceDiversity (vcflib) because it knows its own name and needs no date to be iconic. periodt. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from