calibrate_distribution: Convert mean/dispersion parameterizations
In simulab: Simulates a Wide Variety of Data Shapes, Sizes and Distributions

calibrate_distribution

R Documentation

Convert mean/dispersion parameterizations

Description

calibrate_distribution() inverts the mean and dispersion parameterization used by the formula/variance specification columns into the shape parameters base R's samplers take. For a mean and a variance, and for the wider catalogue, use calibrate_moments().

Usage

calibrate_distribution(
  distribution = c("beta", "gamma", "negative_binomial"),
  mean,
  dispersion
)

Arguments

`distribution`	Beta, gamma, or negative-binomial distribution.
`mean`	Distribution mean.
`dispersion`	Beta precision or gamma/negative-binomial dispersion.

Value

A base data.frame with one row per input value and parameter, and columns distribution, mean, dispersion, parameter and value.

Examples

calibrate_distribution("beta", mean = 0.4, dispersion = 8)
calibrate_distribution("gamma", mean = 10, dispersion = 0.5)
calibrate_distribution("negative_binomial", mean = 5, dispersion = 0.4)

simulab documentation built on Oct. 15, 2026, 5:08 p.m.