setBioMatrixPlotParameters {caOmicsV} | R Documentation

## Set up Plot Parameters for caOmicsV bioMatrix Layout

### Description

Put biomatrix plot parameters to CA_OMICS_ENV environment. All arguments should be validated outside in advance. This function is for internal use only.

### Usage

        setBioMatrixPlotParameters(numOfGenes, numOfSamples, numOfPhenotypes,
                sampleHeight, sampleWidth, columnPadding, rowPadding,
                geneNameWidth, remarkWidth, summaryWidth, sampleNameHeight,
                legendHeight)

### Arguments

`numOfGenes` | non-negative integer, total number of genes to be plotted
`numOfSamples` | non-negative integer, total number of samples to be plotted
`numOfPhenotypes` | non-negative integer, total number of phenotypes to be plotted
`sampleHeight` | non-negative numeric, height of polygon (sample) in inch on each row
`sampleWidth` | non-negative numeric, width of polygon (sample) in inch on each row
`columnPadding` | non-negative numeric, padding width in inch between two polygons (samples)
`rowPadding` | non-negative numeric, padding height in inch between two rows
`geneNameWidth` | non-negative numeric, width of left text plot area in inch for gene names
`remarkWidth` | non-negative numeric, width of plot area in inch for right side text plot (second set of gene names) and/or summary data plot
`summaryWidth` | non-negative numeric, width of plot area in inch on right side of data plot area for summary info plot
`sampleNameHeight` | non-negative numeric, height of plot area in inch for sample names
`legendHeight` | non-negative numeric, height of legend area

### Value

None

### Author(s)

Henry Zhang

### Examples

        #  Internal use only

[Package caOmicsV version 1.18.0 Index]