ColorMapping {ComplexHeatmap} | R Documentation

## Constructor Method for ColorMapping Class

### Description

Constructor Method for ColorMapping Class

### Usage

    ColorMapping(name, colors = NULL, levels = NULL,
        col_fun = NULL, breaks = NULL, na_col = "#FFFFFF")

### Arguments

`name` | Name for this color mapping. The name is automatically generated if it is not specified.
`colors` | Discrete colors.
`levels` | Levels that correspond to `colors`. If `colors` is name indexed, `levels` can be ignored.
`col_fun` | Color mapping function that maps continuous values to colors.
`breaks` | Breaks for the continuous color mapping. If `col_fun` is generated by `colorRamp2`, `breaks` is automatically inferred from the color mapping function.
`na_col` | Colors for `NA` values.

### Details

`colors` and `levels` are used for discrete color mapping, `col_fun` and `breaks` are used for continuous color mapping.

### Value

A `ColorMapping-class` object.

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### Examples

    cm = ColorMapping(colors = c("A" = "red", "B" = "black"))
    cm
    require(circlize)
    col_fun = colorRamp2(c(0, 1), c("white", "red"))
    cm = ColorMapping(col_fun = col_fun)

[Package ComplexHeatmap version 2.2.0 Index]