trunc_opts: Truncation Distribution Options

View source: R/opts.R

trunc_optsR Documentation

Truncation Distribution Options

Description

[Stable] Returns a truncation distribution formatted for usage by downstream functions. See estimate_truncation() for an approach to estimate these distributions.

Usage

trunc_opts(dist = dist_spec())

Arguments

dist

A delay distribution or series of delay distributions reflecting the truncation generated using dist_spec() or estimate_truncation(). Default is an empty call to dist_spec(), i.e. no truncation

Value

A list summarising the input truncation distribution.

Author(s)

Sam Abbott

Sebastian Funk

See Also

convert_to_logmean convert_to_logsd bootstrapped_dist_fit dist_spec

Examples

# no truncation
trunc_opts()

# truncation dist
trunc_opts(dist = dist_spec(mean = 3, sd = 2, max = 10))

EpiNow2 documentation built on Sept. 26, 2023, 5:11 p.m.