CNVKIT_GENEMETRICS(1)

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

✨ CNVKIT_GENEMETRICS ✨

okay bestie, welcome to the cnvkit_genemetrics page from the User Commands section of the manual (that's section 1, iykyk) πŸ’…

🌸 NAME 🌸

cnvkit_genemetrics β€” the way it just identifies targeted genes with copy number gain or loss 🧬✨ periodt.


πŸŽ€ DESCRIPTION πŸŽ€

okay so the usage goes a little something like this:

cnvkit.py genemetrics [-h] [-s SEGMENT] [-t THRESHOLD] [-m MIN_PROBES] [--drop-low-coverage] [-y] [-x {m,y,male,Male,f,x,female,Female}] [-o FILENAME] [--mean] [--median] [--mode] [--ttest] [--stdev] [--sem] [--mad] [--mse] [--iqr] [--bivar] [--ci] [--pi] [-a ALPHA] [-b BOOTSTRAP] filename

she's long, she's detailed, she's serving πŸ’–

🫢 positional arguments:

  • filename β€” this is your processed sample coverage data file, the *.cnr one, aka the output of the fix sub-command. give her the goods and she'll do the rest πŸ“

πŸ’œ options:

  • -h, --help β€” shows this help message and then dips. classic. ✨
  • -s SEGMENT, --segment SEGMENT β€” your segmentation calls file, the .cns one, which is the output of the segment command (yes with the extra ) in the original, she's quirky like that πŸ™ˆ).
  • -t THRESHOLD, --threshold THRESHOLD β€” the copy number change threshold you need to hit before a gene gets reported as a gain or a loss. [Default: 0.2] ⭐
  • -m MIN_PROBES, --min-probes MIN_PROBES β€” the minimum number of covered probes required before she'll report a gain or loss. [Default: 3] πŸ’…
  • --drop-low-coverage β€” drops the very-low-coverage bins before segmentation, which is lowkey important because it avoids those false-positive deletions in poor-quality tumor samples. protective queen πŸ›‘οΈ
  • -y, --male-reference, --haploid-x-reference β€” assumes the inputs were normalized to a male reference. so like, female samples will end up with +1 log-coverage on chrX; otherwise male samples would have -1 on 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} β€” specifies the sample's chromosomal sex as male or female. and if you don't tell her? she'll guess it from the X and Y coverage, which is honestly iconic of her πŸ‘‘
  • -o FILENAME, --output FILENAME β€” the output table file name. name your baby πŸ’–

🌈 Statistics available:

  • --mean β€” mean log2-ratio (unweighted).
  • --median β€” median. the middle child, literally 😭
  • --mode β€” mode, aka the peak density of log2 ratios.
  • --ttest β€” a one-sample t-test of the bin log2 ratios versus 0.0.
  • --stdev β€” standard deviation.
  • --sem β€” standard error of the mean.
  • --mad β€” median absolute deviation (standardized).
  • --mse β€” mean squared error.
  • --iqr β€” inter-quartile range.
  • --bivar β€” Tukey's biweight midvariance. fancy fr fr πŸ”₯
  • --ci β€” confidence interval (by bootstrap).
  • --pi β€” prediction interval.
  • -a ALPHA, --alpha ALPHA β€” the level used to estimate confidence and prediction intervals. use it with --ci and --pi. [Default: 0.05]
  • -b BOOTSTRAP, --bootstrap BOOTSTRAP β€” how many bootstrap iterations to run when estimating the confidence interval; use it with --ci. [Default: 100] πŸŽ€

ngl bestie, the defaults are doing a LOT of heavy lifting here β€” clock them before you go changing anything πŸ’€

and that's the whole page!! cnvkit.py genemetrics 0.9.10, born July 2023 πŸ¦‹ she's a 0.9.10 girlie from July 2023 and she ate, no cap. mwah πŸ’‹ πŸ‘‘

πŸ“¦ where this page comes from