CNVKIT_DIAGRAM(1)

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

✨ NAME ✨

cnvkit_diagram β€” draw copy number (log2 coverages, segments) on chromosomes as a diagram πŸ’…

okay so real quick, bestie: this is the cnvkit_diagram(1) page, and here's the tea πŸ«–

If both the raw probes and the segments are given, it shows them side-by-side on each chromosome β€” segments on the left side, probes on the right side. Iconic layout, no cap.


πŸ’– DESCRIPTION πŸ’–

Here's the whole vibe, in usage form:

usage: cnvkit.py diagram [-h] [-s SEGMENT] [-c CHROMOSOME] [-t THRESHOLD]
                         [-m MIN_PROBES] [-y]
                         [-x {m,y,male,Male,f,x,female,Female}] [--no-shift-xy] [-o FILENAME] [--title TITLE] [--no-gene-labels] [filename]

That's the entire shape of the thing. Let's break it down, babe 🌸


πŸŽ€ positional arguments πŸŽ€

  • filename β€” your processed coverage data file (*.cnr), aka the output of the fix sub-command. That's the glow-up file right there πŸ’–

πŸ”₯ options πŸ”₯

  • -h, --help β€” shows this help message and then dips. bye πŸ‘‹
  • -s SEGMENT, --segment SEGMENT β€” the segmentation calls (.cns), which is the output of the segment command. feed it the segments and it will slay
  • -c CHROMOSOME, --chromosome CHROMOSOME β€” the chromosome to display, e.g. 'chr1'. and no, you can't do a chromosomal range here β€” no range allowed, periodt 🚫
  • -t THRESHOLD, --threshold THRESHOLD β€” the copy number change threshold used to label genes. [Default: 0.5]
  • -m MIN_PROBES, --min-probes MIN_PROBES β€” the minimum number of covered probes needed before a gene gets labeled. [Default: 3]
  • -y, --male-reference, --haploid-x-reference β€” assume the inputs were normalized to a male reference. so basically: female samples will have +1 log-CNR of chrX; otherwise male samples would have -1 chrX. pick your fighter βš”οΈ
  • -x {m,y,male,Male,f,x,female,Female}, --sample-sex {m,y,male,Male,f,x,female,Female}, -g {m,y,male,Male,f,x,female,Female}, --gender {m,y,male,Male,f,x,female,Female} β€” tell it the sample's chromosomal sex, male or female. (Otherwise it just guesses from the X and Y coverage. lowkey impressive of it, honestly πŸ™ˆ)
  • --no-shift-xy β€” don't adjust the X and Y chromosomes according to sample sex. hands off the X and Y, thank you πŸ’…
  • -o FILENAME, --output FILENAME β€” the output PDF file name. that's your final look, bestie πŸ“„

🌸 Plot aesthetics 🌸

this section is literally just about making it pretty, which is of course the most important part πŸ’–

  • --title TITLE β€” the plot title. [Default: sample ID, from filename or -i]
  • --no-gene-labels β€” disables the gene_name labels on the plot. super useful when a lot of CNV were called and the labels are all fighting for the aux cord 😭

ngl bestie, if your plot is a chaotic mess of overlapping gene names, --no-gene-labels is your best friend. she's giving clean.

that's the whole page, you ate it, go draw some chromosomes πŸ¦‹

signing off with love from cnvkit.py diagram 0.9.10, dated July 2023 πŸ’œβœ¨

πŸ“¦ where this page comes from