Debian Codegraph @

debian/man/cnvkit-reference.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_REFERENCE "1" "July 2023" "cnvkit.py reference 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_reference \- Compile a coverage reference from the given files (normal samples).
5 .SH DESCRIPTION
6 usage: cnvkit.py reference [\-h] [\-f FASTA] [\-o FILENAME] [\-c]
7 .TP
8 [\-\-min\-cluster\-size NUM]
9 [\-x {m,y,male,Male,f,x,female,Female}] [\-y]
10 [\-t TARGETS] [\-a ANTITARGETS] [\-\-no\-gc] [\-\-no\-edge]
11 [\-\-no\-rmask]
12 [references ...]
13 .SS "positional arguments:"
14 .TP
15 references
16 Normal\-sample target or antitarget .cnn files, or the
17 directory that contains them.
18 .SS "options:"
19 .TP
20 \fB\-h\fR, \fB\-\-help\fR
21 show this help message and exit
22 .TP
23 \fB\-f\fR FASTA, \fB\-\-fasta\fR FASTA
24 Reference genome, FASTA format (e.g. UCSC hg19.fa)
25 .TP
26 \fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME
27 Output file name.
28 .TP
29 \fB\-c\fR, \fB\-\-cluster\fR
30 Calculate and store summary stats for clustered
31 subsets of the normal samples with similar coverage
32 profiles.
33 .TP
34 \fB\-\-min\-cluster\-size\fR NUM
35 Minimum cluster size to keep in reference profiles.
36 [Default: 4]
37 .TP
38 \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}
39 Specify the chromosomal sex of all given samples as
40 male or female. (Default: guess each sample from
41 coverage of X and Y chromosomes).
42 .TP
43 \fB\-y\fR, \fB\-\-male\-reference\fR, \fB\-\-haploid\-x\-reference\fR
44 Create a male reference: shift female samples' chrX
45 log\-coverage by \fB\-1\fR, so the reference chrX average is
46 \fB\-1\fR. Otherwise, shift male samples' chrX by +1, so the
47 reference chrX average is 0.
48 .SS "To construct a generic, "flat" copy number reference with neutral expected coverage:"
49 .TP
50 \fB\-t\fR TARGETS, \fB\-\-targets\fR TARGETS
51 Target intervals (.bed or .list)
52 .TP
53 \fB\-a\fR ANTITARGETS, \fB\-\-antitargets\fR ANTITARGETS
54 Antitarget intervals (.bed or .list)
55 .SS "To disable specific automatic bias corrections:"
56 .TP
57 \fB\-\-no\-gc\fR
58 Skip GC correction.
59 .TP
60 \fB\-\-no\-edge\fR
61 Skip edge\-effect correction.
62 .TP
63 \fB\-\-no\-rmask\fR
64 Skip RepeatMasker correction.