chmAddSpecificAxisTypeFunction-method: Add a CHM-specific axis type function to a NGCHM.

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

Add a CHM-specific axis type function to a NGCHM.

Description

Adds a CHM-specific axis type function to a Next Generation Clustered Heat Map (NGCHM) and returns the extended CHM. Multiple axis type functions may be added to either axis. When the NGCHM is made, any specific Axis functions matching the specified axis type will be automatically added to the appropriate axis menu.

Usage

chmAddSpecificAxisTypeFunction(chm, where, type, label, func)

## S4 method for signature 'ngchm,character,character,character,ngchmJS'
chmAddSpecificAxisTypeFunction(chm, where, type, label, func)

## S4 method for signature 'ngchm,character,character,character,character'
chmAddSpecificAxisTypeFunction(chm, where, type, label, func)

Arguments

chm	The chm to add the axis type to.
where	The axis to add the axis type to. Must be either "row", "column", or "both".
type	The type expected by the specified function.
label	The label to use if and when the function is added to the menu.
func	A javascript function that accepts a list of values of that type. If a string is provided, the function is obtained by calling chmGetFunction.

Value

The extended chm.

See Also

chmListTypes()

ngchmAxisType

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