Debian Codegraph @

debian/man/cnvkit-heatmap.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_HEATMAP "1" "July 2023" "cnvkit.py heatmap 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_heatmap \- Plot copy number for multiple samples as a heatmap.
5 .SH DESCRIPTION
6 usage: cnvkit.py heatmap [\-h] [\-c CHROMOSOME] [\-y]
7 .TP
8 [\-x {m,y,male,Male,f,x,female,Female}]
9 [\-\-no\-shift\-xy] [\-o FILENAME] [\-b] [\-d] [\-v]
10 [\-\-delimit\-samples] [\-t TITLE]
11 filenames [filenames ...]
12 .SS "positional arguments:"
13 .TP
14 filenames
15 Sample coverages as raw probes (.cnr) or segments
16 (.cns).
17 .SS "options:"
18 .TP
19 \fB\-h\fR, \fB\-\-help\fR
20 show this help message and exit
21 .TP
22 \fB\-c\fR CHROMOSOME, \fB\-\-chromosome\fR CHROMOSOME
23 Chromosome (e.g. 'chr1') or chromosomal range (e.g.
24 \&'chr1:2333000\-2444000') to display. If a range is
25 given, all targeted genes in this range will be shown,
26 unless '\-\-gene'/'\-g' is already given.
27 .TP
28 \fB\-y\fR, \fB\-\-male\-reference\fR, \fB\-\-haploid\-x\-reference\fR
29 Assume inputs were normalized to a male reference
30 (i.e. female samples will have +1 log\-CNR of chrX;
31 otherwise male samples would have \fB\-1\fR chrX).
32 .TP
33 \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}
34 Specify the chromosomal sex of all given samples as
35 male or female. [Default: guess each sample from
36 coverage of X and Y chromosomes].
37 .TP
38 \fB\-\-no\-shift\-xy\fR
39 Don't adjust the X and Y chromosomes according to
40 sample sex.
41 .TP
42 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
43 Output PDF file name.
44 .SS "Plot aesthetics:"
45 .TP
46 \fB\-b\fR, \fB\-\-by\-bin\fR
47 Plot data x\-coordinates by bin indices instead of
48 genomic coordinates. All bins will be shown with equal
49 width, no blank regions will be shown, and x\-axis
50 values indicate bin number (within chromosome) instead
51 of genomic position.
52 .TP
53 \fB\-d\fR, \fB\-\-desaturate\fR
54 Tweak color saturation to focus on significant
55 changes.
56 .TP
57 \fB\-v\fR, \fB\-\-vertical\fR
58 Plot heatmap with samples as X\-axis (instead of
59 Y\-axis).
60 .TP
61 \fB\-\-delimit\-samples\fR
62 Add an horizontal delimitation line between each
63 sample.
64 .TP
65 \fB\-t\fR TITLE, \fB\-\-title\fR TITLE
66 Plot title. [Default: Range if provided, otherwise
67 none]