chmAddCovariateBar-method: Add a covariate bar to a NGCHM.

In bmbroom/NGCHMR: Utilities for Creating Next Generation Clustered Heat Maps

Add a covariate bar to a NGCHM.

Description

Add a covariate bar to a Next Generation Clustered Heat Map (NGCHM) and return the extended CHM. If passed a covariate, a covariate bar will be created (using any optional parameters supplied) and added.

Usage

chmAddCovariateBar(chm, where, covar, ...)

## S4 method for signature 'ngchm,character,ngchmBar'
chmAddCovariateBar(chm, where, covar)

## S4 method for signature 'ngchm,character,ngchmCovariate'
chmAddCovariateBar(chm, where, covar, ...)

## S4 method for signature 'ngchm,character,list'
chmAddCovariateBar(chm, where, covar, ...)

Arguments

chm	The chm to add the covariate bar to.
where	The chm axis(axes) to add the covariate bar to. Must be one of "row", "column", or "both".
covar	The covariate or covariate bar (or a list of them) to add to the chm.
...	Additional parameters passed to chmNewCovariateBar if covar is a covariate.

Details

If a covariate bar with the same name already exists on the specified axis or axes, the existing bar will be replaced by the new bar.

Value

The extended chm.

See Also

chmNewCovariate()

chmNewCovariateBar()

ngchmCovariate

bmbroom/NGCHMR documentation built on April 18, 2022, 6:52 p.m.