Debian Codegraph @

debian/man/cnvkit-genemetrics.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_GENEMETRICS "1" "July 2023" "cnvkit.py genemetrics 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_genemetrics \- Identify targeted genes with copy number gain or loss.
5 .SH DESCRIPTION
6 usage: cnvkit.py genemetrics [\-h] [\-s SEGMENT] [\-t THRESHOLD] [\-m MIN_PROBES]
7 .TP
8 [\-\-drop\-low\-coverage] [\-y]
9 [\-x {m,y,male,Male,f,x,female,Female}]
10 [\-o FILENAME] [\-\-mean] [\-\-median] [\-\-mode]
11 [\-\-ttest] [\-\-stdev] [\-\-sem] [\-\-mad] [\-\-mse]
12 [\-\-iqr] [\-\-bivar] [\-\-ci] [\-\-pi] [\-a ALPHA]
13 [\-b BOOTSTRAP]
14 filename
15 .SS "positional arguments:"
16 .TP
17 filename
18 Processed sample coverage data file (*.cnr), the
19 output of the 'fix' sub\-command.
20 .SS "options:"
21 .TP
22 \fB\-h\fR, \fB\-\-help\fR
23 show this help message and exit
24 .TP
25 \fB\-s\fR SEGMENT, \fB\-\-segment\fR SEGMENT
26 Segmentation calls (.cns), the output of the 'segment'
27 command).
28 .TP
29 \fB\-t\fR THRESHOLD, \fB\-\-threshold\fR THRESHOLD
30 Copy number change threshold to report a gene
31 gain/loss. [Default: 0.2]
32 .TP
33 \fB\-m\fR MIN_PROBES, \fB\-\-min\-probes\fR MIN_PROBES
34 Minimum number of covered probes to report a
35 gain/loss. [Default: 3]
36 .TP
37 \fB\-\-drop\-low\-coverage\fR
38 Drop very\-low\-coverage bins before segmentation to
39 avoid false\-positive deletions in poor\-quality tumor
40 samples.
41 .TP
42 \fB\-y\fR, \fB\-\-male\-reference\fR, \fB\-\-haploid\-x\-reference\fR
43 Assume inputs were normalized to a male reference
44 (i.e. female samples will have +1 log\-coverage of
45 chrX; otherwise male samples would have \fB\-1\fR chrX).
46 .TP
47 \fB\-x\fR {m,y,male,Male,f,x,female,Female}, \fB\-\-sample\-sex\fR {m,y,male,Male,f,x,female,Female}, \fB\-g\fR {m,y,male,Male,f,x,female,Female}, \fB\-\-gender\fR {m,y,male,Male,f,x,female,Female}
48 Specify the sample's chromosomal sex as male or
49 female. (Otherwise guessed from X and Y coverage).
50 .TP
51 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
52 Output table file name.
53 .SS "Statistics available:"
54 .TP
55 \fB\-\-mean\fR
56 Mean log2\-ratio (unweighted).
57 .TP
58 \fB\-\-median\fR
59 Median.
60 .TP
61 \fB\-\-mode\fR
62 Mode (i.e. peak density of log2 ratios).
63 .TP
64 \fB\-\-ttest\fR
65 One\-sample t\-test of bin log2 ratios versus 0.0.
66 .TP
67 \fB\-\-stdev\fR
68 Standard deviation.
69 .TP
70 \fB\-\-sem\fR
71 Standard error of the mean.
72 .TP
73 \fB\-\-mad\fR
74 Median absolute deviation (standardized).
75 .TP
76 \fB\-\-mse\fR
77 Mean squared error.
78 .TP
79 \fB\-\-iqr\fR
80 Inter\-quartile range.
81 .TP
82 \fB\-\-bivar\fR
83 Tukey's biweight midvariance.
84 .TP
85 \fB\-\-ci\fR
86 Confidence interval (by bootstrap).
87 .TP
88 \fB\-\-pi\fR
89 Prediction interval.
90 .TP
91 \fB\-a\fR ALPHA, \fB\-\-alpha\fR ALPHA
92 Level to estimate confidence and prediction intervals;
93 use with \fB\-\-ci\fR and \fB\-\-pi\fR. [Default: 0.05]
94 .TP
95 \fB\-b\fR BOOTSTRAP, \fB\-\-bootstrap\fR BOOTSTRAP
96 Number of bootstrap iterations to estimate confidence
97 interval; use with \fB\-\-ci\fR. [Default: 100]