Debian Codegraph @

debian/man/cnvkit-autobin.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2 .TH CNVKIT_AUTOBIN "1" "July 2023" "cnvkit.py autobin 0.9.10" "User Commands"
3 .SH NAME
4 cnvkit_autobin \- Quickly calculate reasonable bin sizes from BAM read counts.
5 .SH DESCRIPTION
6 usage: cnvkit.py autobin [\-h] [\-f FILENAME] [\-m {hybrid,amplicon,wgs}]
7 .TP
8 [\-g FILENAME] [\-t TARGETS] [\-b BP_PER_BIN]
9 [\-\-target\-max\-size BASES] [\-\-target\-min\-size BASES]
10 [\-\-antitarget\-max\-size BASES]
11 [\-\-antitarget\-min\-size BASES] [\-\-annotate FILENAME]
12 [\-\-short\-names] [\-\-target\-output\-bed FILENAME]
13 [\-\-antitarget\-output\-bed FILENAME]
14 bams [bams ...]
15 .SS "positional arguments:"
16 .TP
17 bams
18 Sample BAM file(s) to test for target coverage
19 .SS "options:"
20 .TP
21 \fB\-h\fR, \fB\-\-help\fR
22 show this help message and exit
23 .TP
24 \fB\-f\fR FILENAME, \fB\-\-fasta\fR FILENAME
25 Reference genome, FASTA format (e.g. UCSC hg19.fa)
26 .TP
27 \fB\-m\fR {hybrid,amplicon,wgs}, \fB\-\-method\fR {hybrid,amplicon,wgs}
28 Sequencing protocol: hybridization capture ('hybrid'),
29 targeted amplicon sequencing ('amplicon'), or whole
30 genome sequencing ('wgs'). Determines whether and how
31 to use antitarget bins. [Default: hybrid]
32 .TP
33 \fB\-g\fR FILENAME, \fB\-\-access\fR FILENAME
34 Sequencing\-accessible genomic regions, or exons to use
35 as possible targets (e.g. output of refFlat2bed.py)
36 .TP
37 \fB\-t\fR TARGETS, \fB\-\-targets\fR TARGETS
38 Potentially targeted genomic regions, e.g. all
39 possible exons for the reference genome. Format: BED,
40 interval list, etc.
41 .TP
42 \fB\-b\fR BP_PER_BIN, \fB\-\-bp\-per\-bin\fR BP_PER_BIN
43 Desired average number of sequencing read bases mapped
44 to each bin. [Default: 100000.0]
45 .TP
46 \fB\-\-target\-max\-size\fR BASES
47 Maximum size of target bins. [Default: 20000]
48 .TP
49 \fB\-\-target\-min\-size\fR BASES
50 Minimum size of target bins. [Default: 20]
51 .TP
52 \fB\-\-antitarget\-max\-size\fR BASES
53 Maximum size of antitarget bins. [Default: 500000]
54 .TP
55 \fB\-\-antitarget\-min\-size\fR BASES
56 Minimum size of antitarget bins. [Default: 500]
57 .TP
58 \fB\-\-annotate\fR FILENAME
59 Use gene models from this file to assign names to the
60 target regions. Format: UCSC refFlat.txt or
61 ensFlat.txt file (preferred), or BED, interval list,
62 GFF, or similar.
63 .TP
64 \fB\-\-short\-names\fR
65 Reduce multi\-accession bait labels to be short and
66 consistent.
67 .TP
68 \fB\-\-target\-output\-bed\fR FILENAME
69 Filename for target BED output. If not specified,
70 constructed from the input file basename.
71 .TP
72 \fB\-\-antitarget\-output\-bed\fR FILENAME
73 Filename for antitarget BED output. If not specified,
74 constructed from the input file basename.