decorate_heatmap_body: Decorate Heatmap Bodies

View source: R/decorate.R

decorate_heatmap_bodyR Documentation

Decorate Heatmap Bodies

Description

Decorate Heatmap Bodies

Usage

decorate_heatmap_body(heatmap, code,
    slice = 1, row_slice = slice, column_slice = 1,
    envir = new.env(parent = parent.frame()))

Arguments

heatmap

Name of the heatmap which is set as name argument in Heatmap function.

code

Code that adds graphics in the selected heatmap body.

slice

Index of the row slice in the heatmap.

row_slice

Index of the row slice in the heatmap.

column_slice

Index of the column slice in the heatmap.

envir

Where to look for variables inside code.

Details

There is a viewport for each slice in each heatmap. This function contructs the name of the viewport, goes to the viewport by seekViewport, runs the code to that viewport and finally goes back to the original viewport.

Value

This function returns no value.

Author(s)

Zuguang Gu <z.gu@dkfz.de>

See Also

https://jokergoo.github.io/ComplexHeatmap-reference/book/heatmap-decoration.html

Examples

set.seed(123)
Heatmap(matrix(rnorm(100), 10), name = "mat")
decorate_heatmap_body("mat", {
    grid.circle(gp = gpar(fill = "#FF000080"))
})

jokergoo/ComplexHeatmap documentation built on Sept. 24, 2024, 4:48 p.m.