Debian Codegraph @

debian/man/cnvkit-segment.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_SEGMENT "1" "July 2023" "cnvkit.py segment 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_segment \- Infer copy number segments from the given coverage table.
5 .SH DESCRIPTION
6 usage: cnvkit.py segment [\-h] [\-o FILENAME] [\-d DATAFRAME]
7 .TP
8 [\-m {cbs,flasso,haar,none,hmm,hmm\-tumor,hmm\-germline}]
9 [\-t THRESHOLD] [\-\-drop\-low\-coverage]
10 [\-\-drop\-outliers FACTOR] [\-\-rscript\-path PATH]
11 [\-p [PROCESSES]] [\-\-smooth\-cbs] [\-v FILENAME]
12 [\-i SAMPLE_ID] [\-n NORMAL_ID]
13 [\-\-min\-variant\-depth MIN_VARIANT_DEPTH]
14 [\-z [ALT_FREQ]]
15 filename
16 .SS "positional arguments:"
17 .TP
18 filename
19 Bin\-level log2 ratios (.cnr file), as produced by
20 \&'fix'.
21 .SS "options:"
22 .TP
23 \fB\-h\fR, \fB\-\-help\fR
24 show this help message and exit
25 .TP
26 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
27 Output table file name (CNR\-like table of segments,
28 \&.cns).
29 .TP
30 \fB\-d\fR DATAFRAME, \fB\-\-dataframe\fR DATAFRAME
31 File name to save the raw R dataframe emitted by CBS
32 or Fused Lasso. (Useful for debugging.)
33 .TP
34 \fB\-m\fR {cbs,flasso,haar,none,hmm,hmm\-tumor,hmm\-germline}, \fB\-\-method\fR {cbs,flasso,haar,none,hmm,hmm\-tumor,hmm\-germline}
35 Segmentation method (see docs), or 'none' for
36 chromosome arm\-level averages as segments. [Default:
37 cbs]
38 .TP
39 \fB\-t\fR THRESHOLD, \fB\-\-threshold\fR THRESHOLD
40 Significance threshold (p\-value or FDR, depending on
41 method) to accept breakpoints during segmentation. For
42 HMM methods, this is the smoothing window size.
43 .TP
44 \fB\-\-drop\-low\-coverage\fR
45 Drop very\-low\-coverage bins before segmentation to
46 avoid false\-positive deletions in poor\-quality tumor
47 samples.
48 .TP
49 \fB\-\-drop\-outliers\fR FACTOR
50 Drop outlier bins more than this many multiples of the
51 95th quantile away from the average within a rolling
52 window. Set to 0 for no outlier filtering. [Default:
53 10]
54 .TP
55 \fB\-\-rscript\-path\fR PATH
56 Path to the Rscript executable to use for running R
57 code. Use this option to specify a non\-default R
58 installation. [Default: Rscript]
59 .TP
60 \fB\-p\fR [PROCESSES], \fB\-\-processes\fR [PROCESSES]
61 Number of subprocesses to segment in parallel. Give 0
62 or a negative value to use the maximum number of
63 available CPUs. [Default: use 1 process]
64 .TP
65 \fB\-\-smooth\-cbs\fR
66 Perform an additional smoothing before CBS
67 segmentation, which in some cases may increase the
68 sensitivity. Used only for CBS method.
69 .SS "To additionally segment SNP b-allele frequencies:"
70 .TP
71 \fB\-v\fR FILENAME, \fB\-\-vcf\fR FILENAME
72 VCF file name containing variants for segmentation by
73 allele frequencies.
74 .TP
75 \fB\-i\fR SAMPLE_ID, \fB\-\-sample\-id\fR SAMPLE_ID
76 Specify the name of the sample in the VCF (\fB\-v\fR/\-\-vcf)
77 to use for b\-allele frequency extraction and as the
78 default plot title.
79 .TP
80 \fB\-n\fR NORMAL_ID, \fB\-\-normal\-id\fR NORMAL_ID
81 Corresponding normal sample ID in the input VCF
82 (\fB\-v\fR/\-\-vcf). This sample is used to select only
83 germline SNVs to plot b\-allele frequencies.
84 .TP
85 \fB\-\-min\-variant\-depth\fR MIN_VARIANT_DEPTH
86 Minimum read depth for a SNV to be displayed in the
87 b\-allele frequency plot. [Default: 20]
88 .TP
89 \fB\-z\fR [ALT_FREQ], \fB\-\-zygosity\-freq\fR [ALT_FREQ]
90 Ignore VCF's genotypes (GT field) and instead infer
91 zygosity from allele frequencies. [Default if used
92 without a number: 0.25]