annotate_heatmap: Add row annotations to a heatmap based on columns from the...

Description Usage Arguments

View source: R/annotate_heatmap.R

Description

Add row annotations to a heatmap based on columns from the 'row_data' entry of a 'heatmap_data' object

Usage

1
2
annotate_heatmap(x, row_annotations = NULL, row_dots = NULL,
  top_annotations = NULL, top_dots = NULL, replace = FALSE)

Arguments

x

A heatmap_data object.

row_annotations

Which columns of the 'row_data' entry in 'x' should be used when plotting annotations alongside the rows of the heatmap?

row_dots, top_dots

Additional arguments to be passed to 'ComplexHeatmap::HeatmapAnnotation' for the next-to-the-heatmap (row_dots) and above-the-heatmap (top_dots) annotations. For example, 'show_legend', 'col'. Check the docs for 'HeatmapAnnotation' for parameter names.

top_annotations

Which columns of the 'column_data' entry in 'x' should be used when plotting annotations above the heatmap?

replace

If TRUE, then any existing row-annotation arguments stored in the heatmap_data will be discarded and replaced with the provided arguments. If FALSE, the provided arguments will append-to or overwrite the existing values.


russHyde/functionalheatmap documentation built on July 9, 2019, 10:30 p.m.