decorate_dend {ComplexHeatmap} | R Documentation

## Decorate the heatmap dendrogram

### Description

Decorate the heatmap dendrogram

### Usage

    decorate_dend(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 each dendrogram in the heatmap. This function contructs the name of the viewport, goes to the viewport by `seekViewport` and applies code to that viewport.

If you know the number of leaves in the dendrogram, it is simple to calculate the position of every leave in the dendrogram. E.g., for the column dendrogram, the i^th leave is located at:

        # assume nc is the number of columns
        unit((i-0.5)/nc, "npc")

### Value

This 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_dend("mat", {
        grid.rect(gp = gpar(fill = "#FF000080"))
    }, which = "row", slice = 2)

[Package ComplexHeatmap version 1.20.0 Index]