Debian Codegraph @

debian/man/cnvkit-diagram.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_DIAGRAM "1" "July 2023" "cnvkit.py diagram 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_diagram \- Draw copy number (log2 coverages, segments) on chromosomes as a diagram.
5
6 If both the raw probes and segments are given, show them side-by-side on
7 each chromosome (segments on the left side, probes on the right side).
8
9 .SH DESCRIPTION
10 usage: cnvkit.py diagram [\-h] [\-s SEGMENT] [\-c CHROMOSOME] [\-t THRESHOLD]
11 .TP
12 [\-m MIN_PROBES] [\-y]
13 [\-x {m,y,male,Male,f,x,female,Female}]
14 [\-\-no\-shift\-xy] [\-o FILENAME] [\-\-title TITLE]
15 [\-\-no\-gene\-labels]
16 [filename]
17 .SS "positional arguments:"
18 .TP
19 filename
20 Processed coverage data file (*.cnr), the output of
21 the 'fix' sub\-command.
22 .SS "options:"
23 .TP
24 \fB\-h\fR, \fB\-\-help\fR
25 show this help message and exit
26 .TP
27 \fB\-s\fR SEGMENT, \fB\-\-segment\fR SEGMENT
28 Segmentation calls (.cns), the output of the 'segment'
29 command.
30 .TP
31 \fB\-c\fR CHROMOSOME, \fB\-\-chromosome\fR CHROMOSOME
32 Chromosome to display, e.g. 'chr1' (no chromosomal
33 range allowed)
34 .TP
35 \fB\-t\fR THRESHOLD, \fB\-\-threshold\fR THRESHOLD
36 Copy number change threshold to label genes. [Default:
37 0.5]
38 .TP
39 \fB\-m\fR MIN_PROBES, \fB\-\-min\-probes\fR MIN_PROBES
40 Minimum number of covered probes to label a gene.
41 [Default: 3]
42 .TP
43 \fB\-y\fR, \fB\-\-male\-reference\fR, \fB\-\-haploid\-x\-reference\fR
44 Assume inputs were normalized to a male reference
45 (i.e. female samples will have +1 log\-CNR of chrX;
46 otherwise male samples would have \fB\-1\fR chrX).
47 .TP
48 \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}
49 Specify the sample's chromosomal sex as male or
50 female. (Otherwise guessed from X and Y coverage).
51 .TP
52 \fB\-\-no\-shift\-xy\fR
53 Don't adjust the X and Y chromosomes according to
54 sample sex.
55 .TP
56 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
57 Output PDF file name.
58 .SS "Plot aesthetics:"
59 .TP
60 \fB\-\-title\fR TITLE
61 Plot title. [Default: sample ID, from filename or \fB\-i]\fR
62 .TP
63 \fB\-\-no\-gene\-labels\fR
64 Disable gene_name labels on plot (useful when a lot of
65 CNV were called).