Debian Codegraph @

debian/man/cnvkit-segmetrics.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_SEGMETRICS "1" "July 2023" "cnvkit.py segmetrics 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_segmetrics \- Compute segment-level metrics from bin-level log2 ratios.
5 .SH DESCRIPTION
6 usage: cnvkit.py segmetrics [\-h] \fB\-s\fR SEGMENTS [\-\-drop\-low\-coverage]
7 .TP
8 [\-o FILENAME] [\-\-mean] [\-\-median] [\-\-mode]
9 [\-\-t\-test] [\-\-stdev] [\-\-sem] [\-\-mad] [\-\-mse]
10 [\-\-iqr] [\-\-bivar] [\-\-ci] [\-\-pi] [\-a ALPHA]
11 [\-b BOOTSTRAP] [\-\-smooth\-bootstrap]
12 cnarray
13 .SS "positional arguments:"
14 .TP
15 cnarray
16 Bin\-level copy ratio data file (*.cnn, *.cnr).
17 .SS "options:"
18 .TP
19 \fB\-h\fR, \fB\-\-help\fR
20 show this help message and exit
21 .TP
22 \fB\-s\fR SEGMENTS, \fB\-\-segments\fR SEGMENTS
23 Segmentation data file (*.cns, output of the 'segment'
24 command).
25 .TP
26 \fB\-\-drop\-low\-coverage\fR
27 Drop very\-low\-coverage bins before calculations to
28 avoid negative bias in poor\-quality tumor samples.
29 .TP
30 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
31 Output table file name.
32 .SS "Statistics available:"
33 .TP
34 \fB\-\-mean\fR
35 Mean log2 ratio (unweighted).
36 .TP
37 \fB\-\-median\fR
38 Median.
39 .TP
40 \fB\-\-mode\fR
41 Mode (i.e. peak density of bin log2 ratios).
42 .TP
43 \fB\-\-t\-test\fR
44 One\-sample t\-test of bin log2 ratios versus 0.0.
45 .TP
46 \fB\-\-stdev\fR
47 Standard deviation.
48 .TP
49 \fB\-\-sem\fR
50 Standard error of the mean.
51 .TP
52 \fB\-\-mad\fR
53 Median absolute deviation (standardized).
54 .TP
55 \fB\-\-mse\fR
56 Mean squared error.
57 .TP
58 \fB\-\-iqr\fR
59 Inter\-quartile range.
60 .TP
61 \fB\-\-bivar\fR
62 Tukey's biweight midvariance.
63 .TP
64 \fB\-\-ci\fR
65 Confidence interval (by bootstrap).
66 .TP
67 \fB\-\-pi\fR
68 Prediction interval.
69 .TP
70 \fB\-a\fR ALPHA, \fB\-\-alpha\fR ALPHA
71 Level to estimate confidence and prediction intervals;
72 use with \fB\-\-ci\fR and \fB\-\-pi\fR. [Default: 0.05]
73 .TP
74 \fB\-b\fR BOOTSTRAP, \fB\-\-bootstrap\fR BOOTSTRAP
75 Number of bootstrap iterations to estimate confidence
76 interval; use with \fB\-\-ci\fR. [Default: 100]
77 .TP
78 \fB\-\-smooth\-bootstrap\fR
79 Apply Gaussian noise to bootstrap samples, a.k.a.
80 smoothed bootstrap, to estimate confidence interval;
81 use with \fB\-\-ci\fR.