R: Plot sample heatmap

plot_sample_heatmap

R Documentation

Plot sample heatmap

Description

Plot sample heatmap using the Jensen-Shannon divergence

Usage

plot_sample_heatmap(obj, use_filtered = TRUE, color_high = "white",
  color_low = "dodgerblue", x_axis_angle = 50,
  annotation_cols = setdiff(colnames(obj$sample_to_covariates), "sample"),
  cluster_bool = TRUE, ...)

Arguments

`obj`	a `sleuth` object
`use_filtered`	if TRUE, use filtered data. otherwise, use everything
`color_high`	the 'high' color (to label samples that are close)
`color_low`	the 'low' color (to label samples that are far apart)
`x_axis_angle`	the angle at which to put the x-axis labels
`annotation_cols`	a character vector of covariates from `sample_to_covariates` that should be annotated on the heatmap
`cluster_bool`	whether the rows and columns should be hierarchically clustered. default is `TRUE`
`...`	additional arguments to customize the heatmap. passed to `pheatmap`. See ?pheatmap for documentation on additional options.

Value

a ggplot2 object