summary.eb: Summary Method for EpiBayes Object

Description Usage Arguments Value See Also

View source: R/summary.eb.R

Description

This function gives summary measurements for posterior distributions of cluster-level prevalences across all time periods considered. It does so by examining the object output by the EpiBayes_ns or EpiBayes_s function of class eb.

Usage

1
2
3
## S3 method for class 'eb'
summary(object, prob = 0.95, burnin = NULL, n.output = NULL,
  ...)

Arguments

object

An object of class ebhistorical (e.g., the output of function EpiBayesHistorical).

prob

The probability associated with the highest posterior density (HPD) intervals one wishes to calculate for each of the reported parameters.

burnin

Number of MCMC iterations to discard from the beginning of the chain. Integer scalar.

n.output

Number of replicated data sets' summary measures to print. Integer scalar.

...

Additional arguments to be passed on to summary.

Value

The summary statistics are returned in a list with the first entry containing the simulation output (p2.tilde, p4.tilde, and p6.tilde), the next containing summary measures for the first ten replicated data sets' gam, and the rest containing summary measures for the first ten replicated data sets' tau values (one for each subzone, if applicable). The summary measurements taken on the posterior distributions include the posterior mean, standard deviation, standard error of the mean, time-series adjusted standard error of the mean, and the lower and upper HPD interval limits, in that order. For reference purposes, below are the descriptions for the summarized variables.

Output Description
p2.tilde Proportion of simulated data sets that result in the probability of poi prevalence below poi.thresh with probability p1
p4.tilde Proportion of simulated data sets that result in the probability of poi prevalence above poi.thresh with probability p1
p6.tilde Proportion of simulated data sets that result in the probability of poi prevalence between poi.lb and poi.ub with probability p1
taumat Posterior distributions of the cluster-level prevalence for all simulated data sets (i.e., reps)
gammat Posterior distribution of the subzone-level prevalence (3-level) OR Posterior distribution of the probability of the disease being in the region (2-level)

See Also

This is a method for objects of class eb returned by the function EpiBayes_ns or EpiBayes_s and creates its own class of object much like the summary method for lm objects.


EpiBayes documentation built on May 30, 2017, 4:01 a.m.