SNP-SITES(1)

πŸ“¦
version 2.5.1 Β· 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

πŸ‘‘ SNP-SITES(1) πŸ‘‘

okay bestie, so this is the manual page for snp-sites, section 1 of the manual. Pull up a chair, grab a boba, and let's get into it πŸ’–


✨ NAME ✨

snp-sites β€” finds SNP sites from a multi FASTA alignment file 🧬


🌸 SYNOPSIS 🌸

snp-sites [-mvph] [-o output_filename] [input file]

that's it. that's the whole vibe check 🫢


πŸ’… DESCRIPTION πŸ’…

okay so what this app does: you hand it a multi fasta alignment, it goes through and finds all the SNP sites, and then it spits those SNP sites back out at you in whichever of these formats you want:

  • multi fasta alignment
  • VCF
  • relaxed phylip format

like, it's giving "I found the spicy columns and I'm handing them to you" and honestly? iconic πŸ”₯


πŸŽ€ OPTIONS πŸŽ€

  • -r β€” output an internal pseudo reference sequence ✨
  • -m β€” output a multi fasta alignment file. this is the default, so if you don't say otherwise, this is what you get πŸ’«
  • -v β€” output a VCF file 🧚
  • -p β€” output a phylip file 🌈
  • -c β€” only output columns that are exclusively ACGT. no ambiguity allowed, no cap πŸ’…
  • -b β€” output monomorphic sites. useful for BEAST πŸ‘‘
  • -o β€” specify an output filename πŸ“
  • -h β€” show the help message πŸ™ˆ
  • -V β€” show version and exit ⭐

🌟 EXAMPLES 🌟

here's the energy you're going for:

snp-sites my-alignment.aln
snp-sites my-gzipped-alignment.aln.gz
snp-sites -cb -o output_beast_format.aln inputfile.aln

yes bestie, gzipped input just works, we love to see it πŸ˜­πŸ’–


πŸ¦‹ FORMAT OF THE INPUT FILE πŸ¦‹

your input files should look like this:

>reference_sequence
aaccggtt
>comparison_sequence
AACCGGTT
>another_comparison_sequence
AACCGCTT

for more examples, visit:

https://github.com/sanger-pathogens/snp-sites/tree/master/tests/data


πŸ’œ AUTHOR πŸ’œ

snp-sites was originally written by Andrew Page (ap13@sanger.ac.uk) 🫢


πŸ‘‘ CITATION πŸ‘‘

if you use this program, please cite: "SNP-sites: rapid efficient extraction of SNPs from multi-FASTA alignments", Andrew J. Page, Ben Taylor, Aidan J. Delaney, Jorge Soares, Torsten Seemann, Jacqueline A. Keane, Simon R. Harris (2016), bioRxiv doi: http://dx.doi.org/10.1101/038190

like, give credit where credit is due, it's the least you can do πŸ’–


🌈 COPYING 🌈

Wellcome Trust Sanger Institute Copyright Β© 2013 Wellcome Trust Sanger Institute This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

yes this part is legally load-bearing, so read it properly, don't just scroll past it πŸ’€

and that's the whole page, bestie. this was SNP-SITES(1) β€” that's the manual page title and the section it lives in, and that's the footer energy too, so we're all caught up πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from