Skip to contents

Plot a niche climate exposure diagram

Usage

plot_climniche_diagram(
  x,
  scope = c("current", "all"),
  type = c("summary", "sample"),
  max_arrows = 350L,
  seed = 1L,
  show_reference = FALSE,
  show_hulls = TRUE,
  boundary_shape = c("hull", "circle", "none"),
  show_boundary_label = TRUE,
  show_points = NULL,
  show_endpoints = FALSE,
  show_center = FALSE,
  show_variables = FALSE,
  variable_labels = NULL,
  title = NULL
)

Arguments

x

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

scope

"current" for current occurrence, range or thresholded SDM cells; "all" for all evaluated cells.

type

"summary" draws class mean arrows; "sample" draws sampled cell arrows and future points.

max_arrows

Maximum number of current to future arrows to draw when type = "sample".

seed

Random seed used when subsampling arrows.

show_reference

Logical; draw the full analysed environmental domain.

show_hulls

Logical; draw current and future niche hulls.

boundary_shape

Boundary display. "hull" draws the empirical occupied niche polygon, "circle" draws a constant niche distance boundary, and "none" suppresses the boundary.

show_boundary_label

Logical; add reference-area explanations below the exposure-class legend.

show_points

Logical; draw future points when type = "sample".

show_endpoints

Logical; draw class mean future positions when type = "summary".

show_center

Logical; mark the realised niche centre.

show_variables

Logical; draw environmental variable directions.

variable_labels

Optional named vector replacing variable labels.

title

Optional plot title.

Value

A ggplot object.