get.highest.density.intervals: Get highest-density intervals (confidence/credible intervals)...

In tfojo1/distributions:

Get highest-density intervals (confidence/credible intervals) for the variables in a distribution

Description

Get highest-density intervals (confidence/credible intervals) for the variables in a distribution

Usage

get.highest.density.intervals(dist, coverage = 0.95, n.sim = 1000)

Arguments

dist	An object of class Distribution or a subclass
coverage	A vector of probabilities (from 0 to 1) which the intervals should cover
n.sim	If the values are to be calculated by random sample generation, how many random samples to generate

Details

Note to developers: This function should not be overridden directly. Insteady override do.get.highest.density.intervals

Value

If length(coverage)==1, and the distribution has one variable, returns a numeric vector with two values: the lower and upper bound of the interval. If length(coverage)==1 and the distribution has more than one variable, returns a matrix with one row for the lower bound and one row for the upper, and one column for each variable. If length(coverage)>1 and the distribution has one variable, returns a matrix with one row for the lower bound and one row for the upper bound, and one column for each value in coverage. If length(coverage)>1, and the distribution has more than one variable returns a 3-dimensional array; the first dimension has values 'lower' and 'upper'. The second dimension has one value for each variable. The third dimension has one value for each value of coverage.

See Also

get.equal.tailed.intervals, get.highest.density.intervals

tfojo1/distributions documentation built on June 1, 2025, 9:07 p.m.