Plot a Distance Heatmap — plot_distance_heatmap • microbiomedataset

Visualize sample distances as a ComplexHeatmap heatmap.

Usage

plot_distance_heatmap(
  object,
  method = c("bray", "jaccard", "euclidean"),
  annotate_by = NULL,
  cluster = TRUE
)

Arguments

object: A microbiome_dataset or beta-type microbiome_diversity object.
method: Distance method used when object is a dataset.
annotate_by: Optional sample metadata columns.
cluster: Should samples be hierarchically clustered?

Value

A ComplexHeatmap::Heatmap object.

Examples

data("global_patterns", package = "microbiomedataset")
plot_distance_heatmap(global_patterns, annotate_by = "SampleType")