add_shaded_quantiles: Add a shaded region showing the min/max quantiles

View source: R/plotting_functions.R

add_shaded_quantilesR Documentation

Add a shaded region showing the min/max quantiles

Description

Add a shaded region showing the min/max quantiles (usually +/-2.5%) to a plot. The input, bayesian_summary, is the result of a call to summarize_bayesian_inference, which is a list-like object of class bd_bayesian_summary with information on the quantiles of the density function and growth rate. Typically, the min/max quantiles are 2.5% and 97.5%, but this can be changed via the input lev in the call to summarize_bayesian_inference.

Usage

add_shaded_quantiles(
  bayesian_summary,
  col = grDevices::adjustcolor("grey", alpha.f = 0.5),
  ...
)

Arguments

bayesian_summary

A list-like object of class bd_bayesian_summary with information on the quantiles of the density function and growth rate (see summarize_bayesian_inference).

col

The color of the shaded region (default: grDevices::adjustcolor("grey",alpha.f = 0.5).

...

Additional parameters to pass to graphics::polygon.

See Also

summarize_bayesian_inference()


eehh-stanford/baydem documentation built on June 3, 2024, 5:46 p.m.