% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/geom-arearange.R
\name{gg_arearange}
\alias{gg_arearange}
\title{ggplot2 Arearange Geom Function}
\usage{
gg_arearange(spec, opts, geom_params)
}
\arguments{
\item{spec}{An \code{\link[=hd_spec]{hd_spec()}} object.}

\item{opts}{An \code{\link[=hd_opts]{hd_opts()}} object.}

\item{geom_params}{Named list of geom-specific arguments (see above).}
}
\value{
A list of \code{ggplot2} layer objects.
}
\description{
Returns a list of ggplot2 layers (ribbon + optional centre line + points)
that the ggplot2 engine adds to the base figure.  Not intended to be called
directly; use \code{\link[=hd_geom_arearange]{hd_geom_arearange()}} or \code{hd_make(..., type = "arearange")}.
}
\section{geom_params recognised}{

\describe{
\item{\code{ymin}}{Character. \strong{Required.} Column name for the lower bound.}
\item{\code{ymax}}{Character. \strong{Required.} Column name for the upper bound.}
\item{\code{show_line}}{Logical. Draw a centre line + open-circle points on top
of the ribbon.  Default \code{TRUE}.}
\item{\code{single_colour}}{Character or \code{NULL}.  Fixed hex colour injected by
the ggplot2 engine for single-series figures.  \code{NULL} for multi-series
figures (colour is handled by \code{\link[=apply_gg_colors]{apply_gg_colors()}}).}
}
}

\keyword{internal}
