| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH CNVKIT_IMPORT-RNA "1" "July 2023" "cnvkit.py import-rna 0.9.10" "User Commands" |
| 3 |
.SH NAME |
| 4 |
cnvkit_import-rna \- Convert a cohort of per-gene log2 ratios to CNVkit .cnr format. |
| 5 |
.SH DESCRIPTION |
| 6 |
usage: cnvkit.py import\-rna [\-h] [\-f NAME] \fB\-g\fR FILE [\-c FILE] |
| 7 |
.TP |
| 8 |
[\-\-max\-log2 FLOAT] [\-n NORMAL [NORMAL ...]] |
| 9 |
[\-d PATH] [\-o FILE] [\-\-no\-gc] [\-\-no\-txlen] |
| 10 |
FILES [FILES ...] |
| 11 |
.SS "positional arguments:" |
| 12 |
.TP |
| 13 |
FILES |
| 14 |
Tabular files with Ensembl gene ID and number of reads |
| 15 |
mapped to each gene, from RSEM or another transcript |
| 16 |
quantifier. |
| 17 |
.SS "options:" |
| 18 |
.TP |
| 19 |
\fB\-h\fR, \fB\-\-help\fR |
| 20 |
show this help message and exit |
| 21 |
.TP |
| 22 |
\fB\-f\fR NAME, \fB\-\-format\fR NAME |
| 23 |
Input format name: 'rsem' for RSEM gene\-level read |
| 24 |
counts (*_rsem.genes.results), or 'counts' for generic |
| 25 |
2\-column gene IDs and their read counts (e.g. TCGA |
| 26 |
level 2 RNA expression). |
| 27 |
.TP |
| 28 |
\fB\-g\fR FILE, \fB\-\-gene\-resource\fR FILE |
| 29 |
Location of gene info table from Ensembl BioMart. |
| 30 |
.TP |
| 31 |
\fB\-c\fR FILE, \fB\-\-correlations\fR FILE |
| 32 |
Correlation of each gene's copy number with |
| 33 |
expression. Output of cnv_expression_correlate.py. |
| 34 |
.TP |
| 35 |
\fB\-\-max\-log2\fR FLOAT |
| 36 |
Maximum log2 ratio in output. Observed values above |
| 37 |
this limit will be replaced with this value. [Default: |
| 38 |
3.0] |
| 39 |
.TP |
| 40 |
\fB\-n\fR NORMAL [NORMAL ...], \fB\-\-normal\fR NORMAL [NORMAL ...] |
| 41 |
Normal samples (same format as `gene_counts`) to be |
| 42 |
used as a control to when normalizing and re\-centering |
| 43 |
gene read depth ratios. All filenames following this |
| 44 |
option will be used. |
| 45 |
.TP |
| 46 |
\fB\-d\fR PATH, \fB\-\-output\-dir\fR PATH |
| 47 |
Directory to write a CNVkit .cnr file for each input |
| 48 |
sample. [Default: .] |
| 49 |
.TP |
| 50 |
\fB\-o\fR FILE, \fB\-\-output\fR FILE |
| 51 |
Output file name (summary table). |
| 52 |
.SS "To disable specific automatic bias corrections:" |
| 53 |
.TP |
| 54 |
\fB\-\-no\-gc\fR |
| 55 |
Skip GC correction. |
| 56 |
.TP |
| 57 |
\fB\-\-no\-txlen\fR |
| 58 |
Skip transcript length correction. |