% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/diagram.R
\name{plot_climniche_diagram}
\alias{plot_climniche_diagram}
\title{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{
\item{x}{A fitted climniche object or data returned by
\code{climniche_diagram_data()}.}

\item{scope}{\code{"current"} for current occurrence, range or thresholded SDM
cells; \code{"all"} for all evaluated cells.}

\item{type}{\code{"summary"} draws class mean arrows; \code{"sample"} draws sampled
cell arrows and future points.}

\item{max_arrows}{Maximum number of current to future arrows to draw when
\code{type = "sample"}.}

\item{seed}{Random seed used when subsampling arrows.}

\item{show_reference}{Logical; draw the full analysed environmental domain.}

\item{show_hulls}{Logical; draw current and future niche hulls.}

\item{boundary_shape}{Boundary display. \code{"hull"} draws the empirical
occupied niche polygon, \code{"circle"} draws a constant niche distance boundary,
and \code{"none"} suppresses the boundary.}

\item{show_boundary_label}{Logical; add reference-area explanations below
the exposure-class legend.}

\item{show_points}{Logical; draw future points when \code{type = "sample"}.}

\item{show_endpoints}{Logical; draw class mean future positions when
\code{type = "summary"}.}

\item{show_center}{Logical; mark the realised niche centre.}

\item{show_variables}{Logical; draw environmental variable directions.}

\item{variable_labels}{Optional named vector replacing variable labels.}

\item{title}{Optional plot title.}
}
\value{
A ggplot object.
}
\description{
Plot a niche climate exposure diagram
}
