gg_arearange: ggplot2 Arearange Geom Function

View source: R/geom-arearange.R

gg_arearangeR Documentation

ggplot2 Arearange Geom Function

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 hd_geom_arearange() or hd_make(..., type = "arearange").

Usage

gg_arearange(spec, opts, geom_params)

Arguments

spec

An hd_spec() object.

opts

An hd_opts() object.

geom_params

Named list of geom-specific arguments (see above).

Value

A list of ggplot2 layer objects.

geom_params recognised

ymin

Character. Required. Column name for the lower bound.

ymax

Character. Required. Column name for the upper bound.

show_line

Logical. Draw a centre line + open-circle points on top of the ribbon. Default TRUE.

single_colour

Character or NULL. Fixed hex colour injected by the ggplot2 engine for single-series figures. NULL for multi-series figures (colour is handled by apply_gg_colors()).


highdir documentation built on July 31, 2026, 5:06 p.m.