layer_text-method: Adds a layers of texts above the heatmap tiles to a...

layer_textR Documentation

Adds a layers of texts above the heatmap tiles to a 'InputHeatmap', that on evaluation creates a 'ComplexHeatmap'

Description

layer_text() from a 'InputHeatmap' object, adds a text annotation layer.

Usage

layer_text(.data, ..., .value, .size = NULL)

## S4 method for signature 'InputHeatmap'
layer_text(.data, ..., .value, .size = NULL)

Arguments

.data

A 'InputHeatmap'

...

Expressions that return a logical value, and are defined in terms of the variables in .data. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept.

.value

A column name or character string.

.size

A column name or a double. The size of the elements of the layer.

Details

\lifecycle

maturing

It uses 'ComplexHeatmap' as visualisation tool.

Value

A 'InputHeatmap' object that gets evaluated to a 'ComplexHeatmap'

A 'InputHeatmap' object that gets evaluated to a 'ComplexHeatmap'

Examples


library(dplyr)

hm = 
  tidyHeatmap::N52 |>
  mutate(my_text = "t") |>
  tidyHeatmap::heatmap(
    .row = symbol_ct,
    .column = UBR,
    .value = `read count normalised log`
) 

hm |> layer_text(.value = "a")
hm |> layer_text(.value = my_text)


stemangiola/tidyHeatmap documentation built on July 30, 2023, 2:14 a.m.