Heatmap-class {ComplexHeatmap} | R Documentation

## Class for a single heatmap

### Description

Class for a single heatmap

### Details

The components for a single heamtap are placed into a 9 x 7 layout:

             +------+ (1)
             +------+ (2)
             +------+ (3)
             +------+ (4)
       +-+-+-+------+-+-+-+
       |1|2|3| 4(5) |5|6|7|
       +-+-+-+------+-+-+-+
             +------+ (6)
             +------+ (7)
             +------+ (8)
             +------+ (9)

From top to bottom in column 4, the regions are:

- title which is put on the top of the heatmap, graphics are drawn by `draw_title,Heatmap-method`.

- column cluster on the top, graphics are drawn by `draw_dend,Heatmap-method`.

- column annotation on the top, graphics are drawn by `draw_annotation,Heatmap-method`.

- column names on the top, graphics are drawn by `draw_dimnames,Heatmap-method`.

- heatmap body, graphics are drawn by `draw_heatmap_body,Heatmap-method`.

- column names on the bottom, graphics are drawn by `draw_dimnames,Heatmap-method`.

- column annotation on the bottom, graphics are drawn by `draw_annotation,Heatmap-method`.

- column cluster on the bottom, graphics are drawn by `draw_dend,Heatmap-method`.

- title on the bottom, graphics are drawn by `draw_title,Heatmap-method`.

From left to right in row 5, the regions are:

- title which is put in the left of the heatmap, graphics are drawn by `draw_title,Heatmap-method`.

- row cluster on the left, graphics are drawn by `draw_dend,Heatmap-method`.

- row names on the left, graphics are drawn by `draw_dimnames,Heatmap-method`.

- heatmap body

- row names on the right, graphics are drawn by `draw_dimnames,Heatmap-method`.

- row cluster on the right, graphics are drawn by `draw_dend,Heatmap-method`.

- title on the right, graphics are drawn by `draw_title,Heatmap-method`.

The `Heatmap-class` is not responsible for heatmap legend and annotation legends. The `draw,Heatmap-method` method will construct a `HeatmapList-class` object which only contains one single heatmap and call `draw,HeatmapList-method` to make a complete heatmap.

### Methods

The `Heatmap-class` provides following methods:

- `Heatmap`: constructor method.

- `draw,Heatmap-method`: draw a single heatmap.

- `add_heatmap,Heatmap-method` append heatmaps and row annotations to a list of heatmaps.

- `row_order,HeatmapList-method`: get order of rows

- `column_order,HeatmapList-method`: get order of columns

- `row_dend,HeatmapList-method`: get row dendrograms

- `column_dend,HeatmapList-method`: get column dendrograms

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### Examples

    # for examples, please go to `Heatmap` method page
    NULL

[Package ComplexHeatmap version 1.18.1 Index]