as.function.epiparameter: 'as.function()' method for <epiparameter> class

View source: R/coercion.R

as.function.epiparameterR Documentation

as.function() method for ⁠<epiparameter>⁠ class

Description

Converts an ⁠<epiparameter>⁠ object to a distribution function (see epiparameter_distribution_functions), either probability density/mass function, (density), cumulative distribution function (cdf), random number generator (generate), or quantile (quantile).

Usage

## S3 method for class 'epiparameter'
as.function(x, func_type = c("density", "cdf", "generate", "quantile"), ...)

Arguments

x

An ⁠<epiparameter>⁠ object.

func_type

A single character string specifying which distribution to convert ⁠<epiparameter>⁠ object into. Default is "density". Other options are "cdf", "generate", or "quantile".

...

dots Extra arguments to be passed to the method.

Details

The function returned takes a single required argument x.

Value

A function object.

Examples

ep <- epiparameter_db(single_epiparameter = TRUE)
# by default it will convert to a density function
f <- as.function(ep)
# use function
f(10)

f <- as.function(ep, func_type = "cdf")
f(10)

epiparameter documentation built on April 3, 2025, 5:50 p.m.