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

Description Usage Arguments Value See Also

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
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,
  display = "visible", thickness = as.integer(10), merge)

## S4 method for signature 'ngchm,character,list'
chmAddCovariateBar(chm, where, covar,
  display = "visible", thickness = as.integer(10), merge = NULL)

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 to add to the chm.

...

Additional parameters passed to chmNewCovariateBar if covar is a covariate.

display

Whether the bar is displayed or not. Defaults to "visible".

thickness

Initial thickness of bar in pixels. Defaults to 10.

merge

Algorithm for merging multiple items into a single pixel. Default.

Value

The extended chm.

See Also

chmNewCovariate

chmNewCovariateBar

ngchmCovariate-class


bmbroom/NGCHMR documentation built on July 28, 2018, 11:17 a.m.