Skip to contents

Plot the climniche summary figure

Usage

plot_climniche_summary_figure(
  x,
  scope = c("current", "all"),
  max_points = 6000L,
  seed = 1L,
  plane_bins = 35L,
  boundary_probs = seq(0.5, 0.99, 0.01),
  top_variables = 6L,
  variable_labels = NULL,
  title = NULL
)

Arguments

x

A fitted climniche object or data returned by climniche_summary_figure_data().

scope

"current" for current reference cells; "all" for all evaluated cells.

max_points

Maximum number of rows retained in the auxiliary plane table. Figure bins use all cells in the selected scope.

seed

Random seed used when subsampling the auxiliary plane table.

plane_bins

Number of fixed bins used to summarize the exposure plane.

boundary_probs

Boundary quantiles retained in the auxiliary figure data.

top_variables

Number of variables to show.

variable_labels

Optional named vector replacing variable labels.

title

Optional overall title when patchwork is installed.

Value

A patchwork object when patchwork is installed, otherwise a named list of ggplot objects.