draw_heatmap_legend-HeatmapList-method: Draw legends for All Heatmaps

In ComplexHeatmap: Make Complex Heatmaps

Description

Draw legends for All Heatmaps

Usage

## S4 method for signature 'HeatmapList'
draw_heatmap_legend(object, legend_list = list(), ...)

Arguments

object	A HeatmapList-class object.
legend_list	A list of self-defined legends, should be wrapped into grob objects. It is normally constructed by Legend.
...	Other arguments.

Details

Actually we call the "heatmap legends" as the main legends. For horizontal heatmap list, the legends are those from heamtap/row annotation/left/right annotation. For vertical heatmap list, the legends are those from heamtap/column annotation/top/bottom annotation. if merge_legends is true in draw,HeatmapList-method, then it contains all legends shown on the plot.

A viewport is created which contains heatmap legends.

This function is only for internal use.

Value

This function returns no value.

Author(s)

Zuguang Gu <[e-mail]>

Examples

# There is no example
NULL

ComplexHeatmap documentation built on Nov. 14, 2020, 2:01 a.m.