MOSDEPTH(1)

πŸ“¦
version 0.3.11 Β· 3 versions
, in ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

mosdepth β€” the manual page for mosdepth 0.3.11, bestie πŸ’– (you'll also see it filed under MOSDEPTH(1))


🌸 DESCRIPTION 🌸

okay so, we're on mosdepth 0.3.11 and here's literally how you run it:

Usage: mosdepth [options] <prefix> <BAM-or-CRAM>

that's the whole vibe. two positional things, a pile of options, and a bunch of very cute output files. let's get into it 🫢

πŸŽ€ Arguments πŸŽ€

  • <prefix> β€” this is your output name stem, and the way it's giving main character energy... every single file below gets built off it:
    • {prefix}.mosdepth.global.dist.txt
    • {prefix}.mosdepth.summary.txt
    • {prefix}.per-base.bed.gz β€” (unless -n/--no-per-base is specified)
    • {prefix}.regions.bed.gz β€” (if --by is specified)
    • {prefix}.quantized.bed.gz β€” (if --quantize is specified)
    • {prefix}.thresholds.bed.gz β€” (if --thresholds is specified)
  • <BAM-or-CRAM> β€” the alignment file for which to calculate depth. yes, exactly that. hand it over πŸ”₯

🧚 Common Options 🧚

  • -t, --threads <threads> β€” number of BAM decompression threads [default: 0]
  • -c, --chrom <chrom> β€” restrict the depth calculation to this one chromosome. just the one, we're being picky πŸ’…
  • -b, --by <bed|window> β€” optional BED file, or an (integer) window-sizes. your call bestie
  • -n, --no-per-base β€” dont output per-base depth. skipping this output will speed execution substantially. prefer quantized or thresholded values if possible.
ngl, if you can live without per-base, do it β€” it's the single biggest speed glow-up on this list ✨
  • -f, --fasta <fasta> β€” fasta file for use with CRAM files [default: ]. CRAM girlies, this one's for you 🧬

πŸ‘‘ Other options πŸ‘‘

  • -F, --flag <FLAG> β€” exclude reads with any of the bits in FLAG set [default: 1796]
  • -i, --include-flag <FLAG> β€” only include reads with any of the bits in FLAG set. default is unset. [default: 0]
  • -x, --fast-mode β€” dont look at internal cigar operations or correct mate overlaps (recommended for most use-cases). lowkey the default move for most people, fr fr
  • -a, --fragment-mode β€” count the coverage of the full fragment including the full insert (proper pairs only). full send, not just the read 🫢
  • -q, --quantize <segments> β€” write quantized output see docs for description. iykyk
  • -Q, --mapq <mapq> β€” mapping quality threshold. reads with a quality less than this value are ignored [default: 0]
  • -l, --min-frag-len <min-frag-len> β€” minimum insert size. reads with a smaller insert size than this are ignored [default: -1]
  • -u, --max-frag-len <max-frag-len> β€” maximum insert size. reads with a larger insert size than this are ignored. [default: -1]
  • -T, --thresholds <thresholds> β€” for each interval in --by, write number of bases covered by at least threshold bases. Specify multiple integer values separated by ,. yes, comma-separated, no spaces, we don't make the rules πŸ’€
  • -m, --use-median β€” output median of each region (in --by) instead of mean. median supremacy πŸŽ€
  • -R, --read-groups <string> β€” only calculate depth for these comma-separated read groups IDs.
  • -h, --help β€” show help. the classic. the icon. when in doubt, hit it 🌈

heads up bestie: --by is doing a lot of heavy lifting here β€” regions.bed.gz, thresholds.bed.gz and use-median all hinge on it, so if something's not showing up, check whether you actually passed --by πŸ¦‹

and that's the whole page!! this was mosdepth 0.3.11, dated September 2025, living in section MOSDEPTH(1) of your friendly neighbourhood manual 🌸 go calculate some depth, you've got this, mwah πŸ’…πŸ’–

πŸ“¦ where this page comes from