SingleAnnotation-class {ComplexHeatmap} | R Documentation

## Class for a single annotation

### Description

Class for a single annotation

### Details

A complex heatmap always has more than one annotations on rows and columns. Here the `SingleAnnotation-class` defines the basic unit of annotations. The most simple annotation is one row or one column grids in which different colors represent different classes of the data. The annotation can also be more complex graphics, such as a boxplot that shows data distribution in corresponding row or column.

The `SingleAnnotation-class` is used for storing data for a single annotation and provides methods for drawing annotation graphics.

### Methods

The `SingleAnnotation-class` provides following methods:

- `SingleAnnotation`: constructor method

- `draw,SingleAnnotation-method`: draw the single annotation.

### Author(s)

Zuguang Gu <z.gu@dkfz.de>

### See Also

The `SingleAnnotation-class` is always used internally. The public `HeatmapAnnotation-class` contains a list of `SingleAnnotation-class` objects and is used to add annotation graphics on heatmaps.

### Examples

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

[Package ComplexHeatmap version 1.20.0 Index]