bound_dist: Define bounds of a <dist_spec>

View source: R/dist_spec.R

bound_distR Documentation

Define bounds of a ⁠<dist_spec>⁠

Description

[Experimental] This sets attributes for further processing

Usage

bound_dist(x, max = Inf, tolerance = 0)

Arguments

x

A ⁠<dist_spec>⁠.

max

Numeric, maximum value of the distribution. The distribution will be truncated at this value. Default: Inf, i.e. no maximum.

tolerance

Numeric; the desired tolerance level. Any part of the cumulative distribution function beyond 1 minus this tolerance level is removed. Default: 0, i.e. use the full distribution.

Value

a ⁠<dist_spec>⁠ with relevant attributes set that define its bounds


epiforecasts/EpiNow2 documentation built on Aug. 15, 2024, 8:12 a.m.