plot_overlay_side: Plot overlay side

In clustree: Visualise Clusterings at Different Resolutions

Plot overlay side

Description

Plot the side view of a clustree overlay plot. If the ordinary plot shows the tree from above this plot shows it from the side, highlighting either the x or y dimension and the clustering resolution.

Usage

plot_overlay_side(
  nodes,
  edges,
  points,
  prefix,
  side_value,
  graph_attr,
  node_size_range,
  edge_width,
  use_colour,
  alt_colour,
  point_size,
  point_alpha,
  point_shape,
  label_nodes,
  label_size,
  y_jitter,
  y_offset
)

Arguments

nodes	data.frame describing nodes
edges	data.frame describing edges
points	data.frame describing points
prefix	string indicating columns containing clustering information
side_value	string giving the metadata column to use for the x axis
graph_attr	list describing graph attributes
node_size_range	numeric vector of length two giving the maximum and minimum point size for plotting nodes
edge_width	numeric value giving the width of plotted edges
use_colour	one of "edges" or "points" specifying which element to apply the colour aesthetic to
alt_colour	colour value to be used for edges or points (whichever is NOT given by use_colour)
point_size	numeric value giving the size of sample points
point_alpha	numeric value giving the alpha of sample points
point_shape	numeric value giving the shape of sample points
label_nodes	logical value indicating whether to add labels to clustering graph nodes
label_size	numeric value giving the size of node labels is label_nodes is TRUE
y_jitter	numeric value giving the y-direction spread of points in side plots
y_offset	numeric value giving the y-direction offset for points in side plots

Value

ggplot object

clustree documentation built on Nov. 6, 2023, 1:07 a.m.