convAnnData: Converting data frames for display as annotation

In alexploner/Heatplus: Heatmaps with row and/or column covariates and colored clusters

Description

Converts a data frames for display as annotation in a heatmap. This is mostly intended as an internal function, but might be useful for finetuning an annotation data frame manually.

Usage

convAnnData(x, nval.fac = 3, inclRef = TRUE, asIs = FALSE)

Arguments

x	the data frame to be converted
nval.fac	lower limit for unique values in numerical variables
inclRef	logical value indicating whether to include the reference level among the dummy variables for factors
asIs	logical value indicating whether to perform a conversion; if TRUE, the input x is simply returned, provided it is a numerical matrix (otherwise, the function stops with an error message)

Details

Logical variables are converted to factors. So are numerical variables with less than nval.fac unique values.

Value

convAnnData returns the converted data frame, which is a numerical matrix

See Also

annHeatmap2

Examples

data(mtcars)
summary(mtcars)
summary(convAnnData(mtcars))
summary(convAnnData(mtcars, nval.fac=2))    
summary(convAnnData(mtcars, nval.fac=2, inclRef=FALSE))    

alexploner/Heatplus documentation built on May 23, 2021, 2:01 p.m.