Skip to contents

add_col_clustering

Source: R/clustering.R
add_col_clustering.Rd

add_col_clustering

Usage

# S4 method for class 'Iheatmap'
add_col_clustering(
  p,
  method = c("hclust", "kmeans", "groups"),
  name = "Col<br>Clusters",
  k = NULL,
  groups = NULL,
  clust_dist = stats::dist,
  colors = NULL,
  show_colorbar = TRUE,
  side = c("top", "bottom"),
  yname = NULL,
  xname = current_xaxis(p)
)

Arguments

p

iheatmap object

method

"hclust" or "kmeans" for hierarchical or k-means clustering, respectively

name

name of colorbar indicating cluster membership

k

number of clusters for rows, needed if order is kmeans or optional if hclust

groups

vector of group assignments

clust_dist

distance function to use for clustering if hierarchical clustering

colors

colors to use for annotation of grouping, can be RColorBrewer palette name or vector of colors

show_colorbar

show the colorbar for the heatmap indicating cluster membership

side

side of plot on which to add subplot

yname

name of yaxis

xname

name of xaxis

Value

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

See also

add_row_clustering, iheatmap

Author

Alicia Schep

Examples


mat <- matrix(rnorm(20), ncol = 5, nrow = 4)
hm <- iheatmap(mat) %>% add_col_clustering(method = "hclust", k = 2)

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