Skip to contents

Plot of cluster assignments in a solutions data frame

Source: R/plot.R
plot.solutions_df.Rd

This plot, built on ComplexHeatmap::Heatmap(), visualizes the cluster assignments in a solutions data frame as a categorical heatmap with observations along the columns and clusters along the rows.

Usage

# S3 method for class 'solutions_df'
plot(
  x,
  y = NULL,
  cluster_rows = FALSE,
  cluster_columns = TRUE,
  heatmap_legend_param = NULL,
  row_title = "Solution",
  column_title = "Observation",
  ...
)

# S3 method for class 't_solutions_df'
plot(x, ...)

Arguments

x

A solutions_df object.

y

Optional argument to plot, not used in this method.

cluster_rows

If the value is a logical, it controls whether to make cluster on rows. The value can also be a hclust or a dendrogram which already contains clustering. Check https://jokergoo.github.io/ComplexHeatmap-reference/book/a-single-heatmap.html#clustering .

cluster_columns

Whether make cluster on columns? Same settings as cluster_rows.

heatmap_legend_param

A list contains parameters for the heatmap legends. See color_mapping_legend,ColorMapping-method for all available parameters.

row_title

Title on the row.

column_title

Title on the column.

...

Additional arguments passed to ComplexHeatmap::Heatmap().

Value

A ComplexHeatmap::Heatmap() object visualization of cluster assignments.