iheatmapr (version 0.7.1)

add_row_clusters: add_row_clusters

Description

Add row groups and order rows based on groups

Usage

# S4 method for Iheatmap
add_row_clusters(
  p,
  clusters,
  name = "Row
Clusters",
  reorder = TRUE,
  side = c("left", "right"),
  yname = current_yaxis(p),
  ...
)

Value

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

Arguments

p

iheatmap object

clusters

cluster assignments, should be vector of integers, characters, or factors

name

name of colorbar indicating cluster membership

reorder

reorder rows based on clusters? default is TRUE

side

side of plot on which to add subplot

yname

name of yaxis

...

additional arguments to pass to add_row_groups for creation of annotation heatmap indicating cluster membership

Author

Alicia Schep

Details

This function is very similar to add_row_groups; the main difference is that with this function rows will get reordered based on the groups.

See Also

add_row_clustering, add_col_clusters, iheatmap

Examples

mat <- matrix(rnorm(20), ncol = 5, nrow = 4)
clusters <- c("A","B","A","B")

hm <- iheatmap(mat) %>% add_row_clusters(clusters)

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