Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

HPDinterval

Highest Posterior Density intervals


Description

Create Highest Posterior Density (HPD) intervals for the parameters in an MCMC sample.

Usage

HPDinterval(obj, prob = 0.95, ...)
## S3 method for class 'mcmc'
HPDinterval(obj, prob = 0.95, ...)
## S3 method for class 'mcmc.list'
HPDinterval(obj, prob = 0.95, ...)

Arguments

obj

The object containing the MCMC sample - usually of class "mcmc" or "mcmc.list"

.

prob

A numeric scalar in the interval (0,1) giving the target probability content of the intervals. The nominal probability content of the intervals is the multiple of 1/nrow(obj) nearest to prob.

...

Optional additional arguments for methods. None are used at present.

Details

For each parameter the interval is constructed from the empirical cdf of the sample as the shortest interval for which the difference in the ecdf values of the endpoints is the nominal probability. Assuming that the distribution is not severely multimodal, this is the HPD interval.

Value

For an "mcmc" object, a matrix with columns "lower" and "upper" and rows corresponding to the parameters. The attribute "Probability" is the nominal probability content of the intervals. A list of such matrices is returned for an "mcmc.list" object.

Author(s)

Douglas Bates

Examples

data(line)
HPDinterval(line)

coda

Output Analysis and Diagnostics for MCMC

v0.19-4
GPL (>= 2)
Authors
Martyn Plummer [aut, cre, trl], Nicky Best [aut], Kate Cowles [aut], Karen Vines [aut], Deepayan Sarkar [aut], Douglas Bates [aut], Russell Almond [aut], Arni Magnusson [aut]
Initial release
2020-09-30

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.