annotation_tile-method: Adds a tile annotation layer to a 'InputHeatmap', that on...

In stemangiola/tidyHeatmap: A Tidy Implementation of Heatmap

Adds a tile annotation layer to a 'InputHeatmap', that on evaluation creates a 'ComplexHeatmap'

Description

annotation_tile() from a 'InputHeatmap' object, adds a tile annotation layer.

Usage

annotation_tile(.data, .column, palette = NULL, size = NULL, ...)

## S4 method for signature 'InputHeatmap'
annotation_tile(.data, .column, palette = NULL, size = NULL, ...)

Arguments

.data	A 'tbl_df' formatted as | <ELEMENT> | <FEATURE> | <VALUE> | <...> |
.column	Vector of quotes
palette	A character vector of colors, or a function such as colorRamp2 (see examples).
size	A grid::unit object, e.g. unit(2, "cm"). This is the height or width of the annotation depending on the orientation.
...	The arguments that will be passed to top_annotation or left_annotation of the ComplexHeatmap container

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 |> annotation_tile(CAPRA_TOTAL)


hm |> 
  annotation_tile(
    inflection, 
    palette = circlize::colorRamp2(c(0, 3,10), c("white", "green", "red"))
 )

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