layer_star-method: Adds a layer of symbols above the heatmap tiles to a...

In stemangiola/tidyHeatmap: A Tidy Implementation of Heatmap

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

Description

layer_star() from a 'InputHeatmap' object, adds a symbol annotation layer over the heatmap tiles.

Usage

layer_star(.data, ..., .size = NULL)

## S4 method for signature 'InputHeatmap'
layer_star(.data, ..., .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.
.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'

Source

[Mangiola and Papenfuss., 2020](https://joss.theoj.org/papers/10.21105/joss.02472)

References

Mangiola, S. and Papenfuss, A.T., 2020. "tidyHeatmap: an R package for modular heatmap production based on tidy principles." Journal of Open Source Software. doi:10.21105/joss.02472.

Examples

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

hm |> layer_star()

stemangiola/tidyHeatmap documentation built on Nov. 2, 2024, 12:54 p.m.