add_col_summary: add_col_summary

Description

Adds a line plot summarizing the values across columns

Usage

# S4 method for Iheatmap
add_col_summary(
  p,
  groups = NULL,
  heatmap_name = NULL,
  colors = NULL,
  tracename = "Col Summary",
  showlegend = FALSE,
  side = c("top", "bottom"),
  layout = list(),
  size = 0.3,
  buffer = 0.02,
  xname = current_xaxis(p),
  yname = NULL,
  type = c("scatter", "bar"),
  summary_function = c("mean", "median", "sd", "var", "mad", "max", "min", "sum"),
  ...
)

Value

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

Arguments

p: Iheatmap-class object
groups: vector of group labels, name of groups colorbar, or TRUE -- see Details
heatmap_name: name of a heatmap within the plot
colors: vector of colors or RColorBrewer palette name
tracename: name of trace
showlegend: show legend?
side: side of plot on which to add subplot
layout: xaxis layout list
size: relative size of subplot relative to main heatmap
buffer: amount of space to leave empty before this plot, relative to size of first heatmap
xname: internal name of xaxis
yname: internal name of yaxis
type: scatter or bar?
summary_function: summary function to use, default is mean, options are mean, median, sd, var, mad, max, min, and sum
...: additional arguments to add_col_plot or add_col_barplot

Author

Alicia Schep

Details

If adding the column summary to a vertically oriented heatmap, the summary will be based on the topmost heatmap if side is "top" and based on the bottom heatmap if side is "bottom" unless a "heatmap_name" is specified. The heatmap_name should match the "pname" argument given to a previously added heatmap.

The column summary is based on specific rows if a "groups" argument is given. The groups argument can either be a vector of group assignments for each row, the "pname" for an existing set of groups incorporated into the plot using add_row_groups, add_row_annotation, add_row_clusters, or add_row_clustering. If groups is set to TRUE, then the function will use an existing set of row groups added to the plot.

Examples

Run this code


mat <- matrix(rnorm(20), ncol = 5, nrow = 4)  
hm1 <- iheatmap(mat) %>% add_col_summary()
hm2 <- iheatmap(mat) %>% add_col_summary(groups = c("A","A","B","B"))

# Print heatmap if interactive session 
if (interactive()) hm1
if (interactive()) hm2

Run the code above in your browser using DataLab

Data Engineering and BI courses are free this week!