CARBayes (version 5.2.5)

summarise.samples: Summarise a matrix of Markov chain Monte Carlo samples.

Description

This function takes in a matrix of Markov chain Monte Carlo (MCMC) samples from a CARBayes model object, such as a set of parameters or fitted values, and calculates posterior quantiles and exceeedence probabilities. The latter are probabilities of the form P(quantity > c|data), where c is a threshold chosen by the user.

Usage

summarise.samples(samples, columns=NULL, quantiles=0.5, exceedences=NULL)

Arguments

samples

A matrix of MCMC samples obtained from a CARBayes model object.

columns

A vector of column numbers stating which columns in the matrix of MCMC samples summaries are required for. Defaults to all columns.

quantiles

The vector of posterior quantiles required.

exceedences

The vector of threshold levels, c, that exceedence probabilities are required for.

Value

quantiles

A 2 dimensional array containing the requied posterior quantiles. Each row relates to a parameter and each column to a different requested quantile.

exceedences

A 2 dimensional array containing the requied exceedence probabilities. Each row relates to a parameter, and each column to a different requested exceedence probability.

Examples

# NOT RUN {
## See the vignette accompanying this package for an example of its use.
# }