add_row_groups: add_row_groups

In iheatmapr: Interactive, Complex Heatmaps

add_row_groups

Description

Adds annotation to heatmap indicating what group every row of main heatmap belongs to

Usage

## S4 method for signature 'Iheatmap'
add_row_groups(
  p,
  groups,
  name = "Row<br>Groups",
  title = "Groups",
  colors = pick_discrete_colors(groups, p),
  colorbar_position = get_colorbar_position(p),
  show_colorbar = TRUE,
  show_title = TRUE,
  side = c("right", "left"),
  layout = list(),
  size = 0.05,
  buffer = 0.005,
  tooltip = setup_tooltip_options(),
  xname = NULL,
  yname = current_yaxis(p),
  pname = name
)

Arguments

p	Iheatmap-class object
groups	vector of group names
name	name of colorbar
title	name of x axis label
colors	palette name or vector of colors
colorbar_position	colorbar placement
show_colorbar	show the colorbar?
show_title	show title as axis label
side	side of plot on which to groups annotation
layout	list of layout parameters for x axis
size	relative size of dendrogram (relative to the main heatmap)
buffer	amount of space to leave empty before this plot, relative to size of first heatmap
tooltip	tooltip options, see setup_tooltip_options
xname	internal name of xaxis
yname	internal name of yaxis
pname	internal name of plot

Value

Iheatmap-class object, which can be printed to generate an interactive graphic

Author(s)

Alicia Schep

See Also

iheatmap, add_col_groups

Examples

mat <- matrix(rnorm(20), ncol = 5, nrow = 4)
row_groups <- c("A","A","B","D")
hm <- iheatmap(mat) %>% add_row_groups(row_groups, name = "My Groups")

# Print heatmap if interactive session 
if (interactive()) hm 

iheatmapr documentation built on May 29, 2024, 8:55 a.m.