| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH CNVKIT_CALL "1" "July 2023" "cnvkit.py call 0.9.10" "User Commands" |
| 3 |
.SH NAME |
| 4 |
cnvkit_call \- Call copy number variants from segmented log2 ratios. |
| 5 |
.SH DESCRIPTION |
| 6 |
usage: cnvkit.py call [\-h] [\-\-center [{mean,median,mode,biweight}]] |
| 7 |
.TP |
| 8 |
[\-\-center\-at CENTER_AT] [\-\-filter {ampdel,cn,ci,sem}] |
| 9 |
[\-m {threshold,clonal,none}] [\-t THRESHOLDS] |
| 10 |
[\-\-ploidy PLOIDY] [\-\-purity PURITY] |
| 11 |
[\-\-drop\-low\-coverage] |
| 12 |
[\-x {m,y,male,Male,f,x,female,Female}] [\-y] |
| 13 |
[\-o FILENAME] [\-v FILENAME] [\-i SAMPLE_ID] |
| 14 |
[\-n NORMAL_ID] [\-\-min\-variant\-depth MIN_VARIANT_DEPTH] |
| 15 |
[\-z [ALT_FREQ]] |
| 16 |
filename |
| 17 |
.SS "positional arguments:" |
| 18 |
.TP |
| 19 |
filename |
| 20 |
Copy ratios (.cnr or .cns). |
| 21 |
.SS "options:" |
| 22 |
.TP |
| 23 |
\fB\-h\fR, \fB\-\-help\fR |
| 24 |
show this help message and exit |
| 25 |
.TP |
| 26 |
\fB\-\-center\fR [{mean,median,mode,biweight}] |
| 27 |
Re\-center the log2 ratio values using this estimator |
| 28 |
of the center or average value. ('median' if no |
| 29 |
argument given.) |
| 30 |
.TP |
| 31 |
\fB\-\-center\-at\fR CENTER_AT |
| 32 |
Subtract a constant number from all log2 ratios. For |
| 33 |
"manual" re\-centering, in case the \fB\-\-center\fR option |
| 34 |
gives unsatisfactory results.) |
| 35 |
.TP |
| 36 |
\fB\-\-filter\fR {ampdel,cn,ci,sem} |
| 37 |
Merge segments flagged by the specified filter(s) with |
| 38 |
the adjacent segment(s). |
| 39 |
.TP |
| 40 |
\fB\-m\fR {threshold,clonal,none}, \fB\-\-method\fR {threshold,clonal,none} |
| 41 |
Calling method. [Default: threshold] |
| 42 |
.TP |
| 43 |
\fB\-t\fR THRESHOLDS, \fB\-\-thresholds\fR THRESHOLDS |
| 44 |
Hard thresholds for calling each integer copy number, |
| 45 |
separated by commas. Use the '=' sign on the command |
| 46 |
line, e.g.: \fB\-t\fR=\fI\,\-1\/\fR,0,1 [Default: \fB\-1\fR.1,\-0.25,0.2,0.7] |
| 47 |
.TP |
| 48 |
\fB\-\-ploidy\fR PLOIDY |
| 49 |
Ploidy of the sample cells. [Default: 2] |
| 50 |
.TP |
| 51 |
\fB\-\-purity\fR PURITY |
| 52 |
Estimated tumor cell fraction, a.k.a. purity or |
| 53 |
cellularity. |
| 54 |
.TP |
| 55 |
\fB\-\-drop\-low\-coverage\fR |
| 56 |
Drop very\-low\-coverage bins before segmentation to |
| 57 |
avoid false\-positive deletions in poor\-quality tumor |
| 58 |
samples. |
| 59 |
.TP |
| 60 |
\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} |
| 61 |
Specify the sample's chromosomal sex as male or |
| 62 |
female. (Otherwise guessed from X and Y coverage). |
| 63 |
.TP |
| 64 |
\fB\-y\fR, \fB\-\-male\-reference\fR, \fB\-\-haploid\-x\-reference\fR |
| 65 |
Was a male reference used? If so, expect half ploidy |
| 66 |
on chrX and chrY; otherwise, only chrY has half |
| 67 |
ploidy. In CNVkit, if a male reference was used, the |
| 68 |
"neutral" copy number (ploidy) of chrX is 1; chrY is |
| 69 |
haploid for either reference sex. |
| 70 |
.TP |
| 71 |
\fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME |
| 72 |
Output table file name (CNR\-like table of segments, |
| 73 |
\&.cns). |
| 74 |
.SS "To additionally process SNP b-allele frequencies for allelic copy number:" |
| 75 |
.TP |
| 76 |
\fB\-v\fR FILENAME, \fB\-\-vcf\fR FILENAME |
| 77 |
VCF file name containing variants for calculation of |
| 78 |
b\-allele frequencies. |
| 79 |
.TP |
| 80 |
\fB\-i\fR SAMPLE_ID, \fB\-\-sample\-id\fR SAMPLE_ID |
| 81 |
Name of the sample in the VCF (\fB\-v\fR/\-\-vcf) to use for |
| 82 |
b\-allele frequency extraction. |
| 83 |
.TP |
| 84 |
\fB\-n\fR NORMAL_ID, \fB\-\-normal\-id\fR NORMAL_ID |
| 85 |
Corresponding normal sample ID in the input VCF |
| 86 |
(\fB\-v\fR/\-\-vcf). This sample is used to select only |
| 87 |
germline SNVs to calculate b\-allele frequencies. |
| 88 |
.TP |
| 89 |
\fB\-\-min\-variant\-depth\fR MIN_VARIANT_DEPTH |
| 90 |
Minimum read depth for a SNV to be used in the |
| 91 |
b\-allele frequency calculation. [Default: 20] |
| 92 |
.TP |
| 93 |
\fB\-z\fR [ALT_FREQ], \fB\-\-zygosity\-freq\fR [ALT_FREQ] |
| 94 |
Ignore VCF's genotypes (GT field) and instead infer |
| 95 |
zygosity from allele frequencies. [Default if used |
| 96 |
without a number: 0.25] |