| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH CNVKIT_SCATTER "1" "July 2023" "cnvkit.py scatter 0.9.10" "User Commands" |
| 3 |
.SH NAME |
| 4 |
cnvkit_scatter \- Plot probe log2 coverages and segmentation calls together. |
| 5 |
.SH DESCRIPTION |
| 6 |
usage: cnvkit.py scatter [\-h] [\-s FILENAME] [\-c RANGE] [\-g GENE] |
| 7 |
.TP |
| 8 |
[\-l RANGE_LIST] [\-w WIDTH] [\-o FILENAME] |
| 9 |
[\-a CHARACTER] [\-\-by\-bin] |
| 10 |
[\-\-segment\-color SEGMENT_COLOR] [\-\-title TITLE] [\-t] |
| 11 |
[\-\-y\-max Y_MAX] [\-\-y\-min Y_MIN] |
| 12 |
[\-\-fig\-size WIDTH HEIGHT] [\-v FILENAME] |
| 13 |
[\-i SAMPLE_ID] [\-n NORMAL_ID] [\-m MIN_VARIANT_DEPTH] |
| 14 |
[\-z [ALT_FREQ]] |
| 15 |
[filename] |
| 16 |
.SS "positional arguments:" |
| 17 |
.TP |
| 18 |
filename |
| 19 |
Processed bin\-level copy ratios (*.cnr), the output of |
| 20 |
the 'fix' sub\-command. |
| 21 |
.SS "options:" |
| 22 |
.TP |
| 23 |
\fB\-h\fR, \fB\-\-help\fR |
| 24 |
show this help message and exit |
| 25 |
.TP |
| 26 |
\fB\-s\fR FILENAME, \fB\-\-segment\fR FILENAME |
| 27 |
Segmentation calls (.cns), the output of the 'segment' |
| 28 |
command. |
| 29 |
.TP |
| 30 |
\fB\-c\fR RANGE, \fB\-\-chromosome\fR RANGE |
| 31 |
Chromosome or chromosomal range, e.g. 'chr1' or |
| 32 |
\&'chr1:2333000\-2444000', to display. If a range is |
| 33 |
given, all targeted genes in this range will be shown, |
| 34 |
unless \fB\-g\fR/\-\-gene is also given. |
| 35 |
.TP |
| 36 |
\fB\-g\fR GENE, \fB\-\-gene\fR GENE |
| 37 |
Name of gene or genes (comma\-separated) to display. |
| 38 |
.TP |
| 39 |
\fB\-l\fR RANGE_LIST, \fB\-\-range\-list\fR RANGE_LIST |
| 40 |
File listing the chromosomal ranges to display, as |
| 41 |
BED, interval list or 'chr:start\-end' text. Creates |
| 42 |
focal plots similar to \fB\-c\fR/\-\-chromosome for each listed |
| 43 |
region, combined into a multi\-page PDF. The output |
| 44 |
filename must also be specified (\fB\-o\fR/\-\-output). |
| 45 |
.TP |
| 46 |
\fB\-w\fR WIDTH, \fB\-\-width\fR WIDTH |
| 47 |
Width of margin to show around the selected gene(s) |
| 48 |
(\fB\-g\fR/\-\-gene) or small chromosomal region |
| 49 |
(\fB\-c\fR/\-\-chromosome). [Default: 1000000] |
| 50 |
.TP |
| 51 |
\fB\-o\fR FILENAME, \fB\-\-output\fR FILENAME |
| 52 |
Output PDF file name. |
| 53 |
.SS "Plot aesthetics:" |
| 54 |
.TP |
| 55 |
\fB\-a\fR CHARACTER, \fB\-\-antitarget\-marker\fR CHARACTER |
| 56 |
Plot antitargets using this symbol when plotting in a |
| 57 |
selected chromosomal region (\fB\-g\fR/\-\-gene or |
| 58 |
\fB\-c\fR/\-\-chromosome). [Default: same as targets] |
| 59 |
.TP |
| 60 |
\fB\-\-by\-bin\fR |
| 61 |
Plot data x\-coordinates by bin indices instead of |
| 62 |
genomic coordinates. All bins will be shown with equal |
| 63 |
width, no blank regions will be shown, and x\-axis |
| 64 |
values indicate bin number (within chromosome) instead |
| 65 |
of genomic position. |
| 66 |
.TP |
| 67 |
\fB\-\-segment\-color\fR SEGMENT_COLOR |
| 68 |
Plot segment lines in this color. Value can be any |
| 69 |
string accepted by matplotlib, e.g. 'red' or |
| 70 |
\&'#CC0000'. |
| 71 |
.TP |
| 72 |
\fB\-\-title\fR TITLE |
| 73 |
Plot title. [Default: sample ID, from filename or \fB\-i]\fR |
| 74 |
.TP |
| 75 |
\fB\-t\fR, \fB\-\-trend\fR |
| 76 |
Draw a smoothed local trendline on the scatter plot. |
| 77 |
.TP |
| 78 |
\fB\-\-y\-max\fR Y_MAX |
| 79 |
y\-axis upper limit. |
| 80 |
.TP |
| 81 |
\fB\-\-y\-min\fR Y_MIN |
| 82 |
y\-axis lower limit. |
| 83 |
.TP |
| 84 |
\fB\-\-fig\-size\fR WIDTH HEIGHT |
| 85 |
Width and height of the plot in inches. [Default: Predefined in Matplotlib 'rcParams' variable (most of the |
| 86 |
time: '6.4 4.8')] |
| 87 |
.SS "To plot SNP b-allele frequencies:" |
| 88 |
.TP |
| 89 |
\fB\-v\fR FILENAME, \fB\-\-vcf\fR FILENAME |
| 90 |
VCF file name containing variants to plot for SNV |
| 91 |
b\-allele frequencies. |
| 92 |
.TP |
| 93 |
\fB\-i\fR SAMPLE_ID, \fB\-\-sample\-id\fR SAMPLE_ID |
| 94 |
Name of the sample in the VCF to use for b\-allele |
| 95 |
frequency extraction and as the default plot title. |
| 96 |
.TP |
| 97 |
\fB\-n\fR NORMAL_ID, \fB\-\-normal\-id\fR NORMAL_ID |
| 98 |
Corresponding normal sample ID in the input VCF. This |
| 99 |
sample is used to select only germline SNVs to plot. |
| 100 |
.TP |
| 101 |
\fB\-m\fR MIN_VARIANT_DEPTH, \fB\-\-min\-variant\-depth\fR MIN_VARIANT_DEPTH |
| 102 |
Minimum read depth for a SNV to be used in the |
| 103 |
b\-allele frequency calculation. [Default: 20] |
| 104 |
.TP |
| 105 |
\fB\-z\fR [ALT_FREQ], \fB\-\-zygosity\-freq\fR [ALT_FREQ] |
| 106 |
Ignore VCF's genotypes (GT field) and instead infer |
| 107 |
zygosity from allele frequencies. [Default if used |
| 108 |
without a number: 0.25] |