decorate_title {ComplexHeatmap}R Documentation

Decorate the heatmap title

Description

Decorate the heatmap title

Usage

decorate_title(heatmap, code, slice = 1, which = c("column", "row"),
    envir = new.env(parent = parent.frame()))

Arguments

heatmap

name of the heatmap

code

code that adds graphics in the selected heatmap body

slice

index of row slices in the heatmap

which

on rows or on columns?

envir

where to look for variables inside code

Details

There is a viewport for row titles and column title in the heatmap. This function contructs the name of the viewport, goes to the viewport by seekViewport and applies code to that viewport.

Value

The function returns no value.

Author(s)

Zuguang Gu <z.gu@dkfz.de>

Examples

set.seed(123)
Heatmap(matrix(rnorm(100), 10), name = "mat", km = 2)
decorate_title("mat", {
    grid.rect(gp = gpar(fill = "#FF000080"))
}, which = "row", slice = 2)

[Package ComplexHeatmap version 1.18.1 Index]