chmAddAxisType-method: Add an axis type to a NGCHM.

chmAddAxisTypeR Documentation

Add an axis type to a NGCHM.

Description

Adds an axis type to a Next Generation Clustered Heat Map (NGCHM) and returns the extended CHM. Multiple axis types may be added to either axis. When the NGCHM is made, any Axis functions matching the specified axis type will be automatically added to the appropriate axis menu, and any Matrix functions matching the types of the rows and columns will be automatically added to the matrix menu.

Usage

chmAddAxisType(chm, where, type, func)

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

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

## S4 method for signature 'ngchm,character,character,missing'
chmAddAxisType(chm, where, type, func)

Arguments

chm

The chm to add the axis type to.

where

The axis to add the axis type to. Must be either "row" or "column".

type

The type to add to the specified axis.

func

A javascript function that gets values of that type from the current selection. If a string is provided, the function is obtained by calling chmGetFunction.

Value

The extended chm.

See Also

chmListTypes()

chmRegisterAxisFunction()

chmRegisterMatrixFunction()

chmRegisterTypeMapper()

ngchmAxisType


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