| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH CNVKIT.PY "1" "July 2023" "cnvkit.py 0.9.10" "User Commands" |
| 3 |
.SH NAME |
| 4 |
cnvkit.py \- Copy number variant detection from targeted DNA sequencing |
| 5 |
.SH DESCRIPTION |
| 6 |
usage: cnvkit.py [\-h] |
| 7 |
.IP |
| 8 |
{batch,target,access,antitarget,autobin,coverage,reference,fix,segment,call,diagram,scatter,heatmap,breaks,genemetrics,gainloss,sex,gender,metrics,segmetrics,bintest,import\-picard,import\-seg,import\-theta,import\-rna,export,version} |
| 9 |
\&... |
| 10 |
.PP |
| 11 |
CNVkit, a command\-line toolkit for copy number analysis. |
| 12 |
.SS "positional arguments:" |
| 13 |
.TP |
| 14 |
{batch,target,access,antitarget,autobin,coverage,reference,fix,segment,call,diagram,scatter,heatmap,breaks,genemetrics,gainloss,sex,gender,metrics,segmetrics,bintest,import\-picard,import\-seg,import\-theta,import\-rna,export,version} |
| 15 |
Sub\-commands (use with \fB\-h\fR for more info) |
| 16 |
.TP |
| 17 |
batch |
| 18 |
Run the complete CNVkit pipeline on one or more BAM |
| 19 |
files. |
| 20 |
.TP |
| 21 |
target |
| 22 |
Transform bait intervals into targets more suitable |
| 23 |
for CNVkit. |
| 24 |
.TP |
| 25 |
access |
| 26 |
List the locations of accessible sequence regions in a |
| 27 |
FASTA file. |
| 28 |
.TP |
| 29 |
antitarget |
| 30 |
Derive off\-target ("antitarget") bins from target |
| 31 |
regions. |
| 32 |
.TP |
| 33 |
autobin |
| 34 |
Quickly calculate reasonable bin sizes from BAM read |
| 35 |
counts. |
| 36 |
.TP |
| 37 |
coverage |
| 38 |
Calculate coverage in the given regions from BAM read |
| 39 |
depths. |
| 40 |
.TP |
| 41 |
reference |
| 42 |
Compile a coverage reference from the given files |
| 43 |
(normal samples). |
| 44 |
.TP |
| 45 |
fix |
| 46 |
Combine target and antitarget coverages and correct |
| 47 |
for biases. Adjust raw coverage data according to the |
| 48 |
given reference, correct potential biases and recenter. |
| 49 |
.TP |
| 50 |
segment |
| 51 |
Infer copy number segments from the given coverage |
| 52 |
table. |
| 53 |
.TP |
| 54 |
call |
| 55 |
Call copy number variants from segmented log2 ratios. |
| 56 |
.TP |
| 57 |
diagram |
| 58 |
Draw copy number (log2 coverages, segments) on |
| 59 |
chromosomes as a diagram. If both the raw probes and |
| 60 |
segments are given, show them side\-by\-side on each |
| 61 |
chromosome (segments on the left side, probes on the |
| 62 |
right side). |
| 63 |
.TP |
| 64 |
scatter |
| 65 |
Plot probe log2 coverages and segmentation calls |
| 66 |
together. |
| 67 |
.TP |
| 68 |
heatmap |
| 69 |
Plot copy number for multiple samples as a heatmap. |
| 70 |
.TP |
| 71 |
breaks |
| 72 |
List the targeted genes in which a copy number |
| 73 |
breakpoint occurs. |
| 74 |
.TP |
| 75 |
genemetrics |
| 76 |
Identify targeted genes with copy number gain or loss. |
| 77 |
.TP |
| 78 |
sex |
| 79 |
Guess samples' sex from the relative coverage of |
| 80 |
chromosomes X and Y. |
| 81 |
.TP |
| 82 |
metrics |
| 83 |
Compute coverage deviations and other metrics for |
| 84 |
self\-evaluation. |
| 85 |
.TP |
| 86 |
segmetrics |
| 87 |
Compute segment\-level metrics from bin\-level log2 |
| 88 |
ratios. |
| 89 |
.TP |
| 90 |
bintest |
| 91 |
Test for single\-bin copy number alterations. |
| 92 |
.TP |
| 93 |
import\-picard |
| 94 |
Convert Picard CalculateHsMetrics tabular output to |
| 95 |
CNVkit .cnn files. The input file is generated by the |
| 96 |
PER_TARGET_COVERAGE option in the CalculateHsMetrics |
| 97 |
script in Picard tools. If 'antitarget' is in the |
| 98 |
input filename, the generated output filename will |
| 99 |
have the suffix '.antitargetcoverage.cnn', otherwise |
| 100 |
\&'.targetcoverage.cnn'. |
| 101 |
.TP |
| 102 |
import\-seg |
| 103 |
Convert a SEG file to CNVkit .cns files. |
| 104 |
.TP |
| 105 |
import\-theta |
| 106 |
Convert THetA output to a BED\-like, CNVkit\-like |
| 107 |
tabular format. Equivalently, use the THetA results |
| 108 |
file to convert CNVkit .cns segments to integer copy |
| 109 |
number calls. |
| 110 |
.TP |
| 111 |
import\-rna |
| 112 |
Convert a cohort of per\-gene log2 ratios to CNVkit |
| 113 |
\&.cnr format. |
| 114 |
.TP |
| 115 |
export |
| 116 |
Convert CNVkit output files to another format. |
| 117 |
.TP |
| 118 |
version |
| 119 |
Display this program's version. |
| 120 |
.SS "options:" |
| 121 |
.TP |
| 122 |
\fB\-h\fR, \fB\-\-help\fR |
| 123 |
show this help message and exit |
| 124 |
.PP |
| 125 |
See the online manual for details: https://cnvkit.readthedocs.io |
| 126 |
.SH AUTHOR |
| 127 |
This manpage was written by Andreas Tille for the Debian distribution and |
| 128 |
can be used for any other usage of the program. |