prepare_annotation: Prepare annotation parameters and positions

In ggcorrheatmap: Make Flexible 'ggplot2' Correlation Heatmaps

Prepare annotation parameters and positions

Description

Prepare annotation parameters and positions

Usage

prepare_annotation(
  annot_df,
  annot_defaults,
  annot_params,
  annot_side,
  context = c("rows", "cols"),
  annot_names_size,
  annot_name_params,
  annot_names_side,
  data_size,
  x_long,
  annot_names_strategy = "geom"
)

Arguments

annot_df	Annotation data frame. Should contain the rownames or a column called '.names' with names, other columns are used for annotation
annot_defaults	Default parameters for annotation.
annot_params	Provided annotation parameters to update.
annot_side	String for annotation side.
context	String stating the context ("rows" or "cols").
annot_names_size	Size of annotation names.
annot_name_params	Annotation label (names next to annotations) parameters to update.
annot_names_side	Annotation label side.
data_size	Size of data (ncol if row annotations, nrow if column annotations).
x_long	Long format plotting data, to see if there are any facets to take into account.
annot_names_strategy	String stating how to draw names (geom, grid). To deal with deprecated argument.

Value

List with updated annotation parameters, calculated annotation positions, and updated annotation label parameters.

ggcorrheatmap documentation built on Aug. 25, 2025, 1:11 a.m.