SAM-STATS(1)

πŸ’– SAM-STATS(1) πŸ’–

okay bestie, welcome to sam-stats β€” that's sam-stats, section 1 of the User Commands manual, and she is the ea-utils girlie who produces digested statistics. yes literally. she chews up your alignment files and spits out stats that are, unlike your ex, easy to digest. 🫢


✨ NAME ✨

sam-stats β€” ea-utils: produce digested statistics 🌸


πŸŽ€ SYNOPSIS πŸŽ€

sam-stats [options] [file1] [file2...filen]

πŸ¦‹ DESCRIPTION πŸ¦‹

Version: 1.38.681

She produces lots of easily digested statistics for the files you list. that's it, that's the job, and she ate. πŸ’…

Options (default in parens):

  • -D β€” keep track of multiple alignments. yes bestie, all of them. πŸ‘€
  • -O PREFIX β€” output prefix enabling extended output (see below)
  • -R FIL β€” coverage/RNA output (coverage, 3' bias, etc, implies -A) 🌈
  • -A β€” report all chr sigs, even if there are more than 1000
  • -b INT β€” number of reads to sample for per-base stats (1M)
  • -S INT β€” size of ascii-signature (30)
  • -x FIL β€” file extension for handling multiple files (stats)
  • -M β€” only overwrite if newer (requires -x, or multiple files)
  • -B β€” input is bam, don't bother looking at magic πŸ”₯
  • -z β€” don't fail when zero entries in sam

πŸ’œ OUTPUT πŸ’œ

If one file is specified, then the output is to standard out. If multiple files are specified, or if the -x option is supplied, the output file is <filename>.<ext>. Default extension is stats.


🌟 Complete Stats 🌟

<STATS> : mean, max, stdev, median, Q1 (25 percentile), Q3

reads : # of entries in the sam file, might not be # reads

phred : phred scale used

bsize : # reads used for qual stats

mapped reads : number of aligned reads (unique probe id sequences)

mapped bases : total of the lengths of the aligned reads

forward : number of forward-aligned reads

reverse : number of reverse-aligned reads

snp rate : mismatched bases / total bases (snv rate)

ins rate : insert bases / total bases

del rate : deleted bases / total bases

pct mismatch : percent of reads that have mismatches

pct align : percent of reads that aligned

len <STATS> : read length stats, ignored if fixed-length

mapq <STATS> : stats for mapping qualities

insert <STATS> : stats for insert sizes

%<CHR> : percentage of mapped bases per chr, followed by a signature


✨ Subsampled stats (1M reads max) ✨

base qual <STATS> : stats for base qualities

%A,%T,%C,%G : base percentages


🧚 Meaning of the per-chromosome signature 🧚

A ascii-histogram of mapped reads by chromosome position. It is only output if the original SAM/BAM has a header. The values are the log2 of the # of mapped reads at each position + ascii '0'.


πŸ‘‘ Extended output mode πŸ‘‘

Extended output mode produces a set of files:

  • .stats : primary output
  • .fastx : fastx-toolkit compatible output
  • .rcov : per-reference counts & coverage
  • .xdist : mismatch distribution
  • .ldist : length distribution (if applicable)
  • .mqdist : mapping quality distribution
not me emotionally attached to .ldist when it says "(if applicable)" 😭 she's conditional, she's mysterious, she's iconic.

and that's the whole page, bestie!! this was sam-stats version 1.1.2, dropped July 2015 β€” go get those digested stats, you absolute main character πŸ’–βœ¨πŸŽ€