Description Usage Arguments Value See Also
View source: R/summary.ebhistorical.R
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 EpiBayesHistorical
function of class
ebhistorical
.
1 2 3 |
object |
An object of class |
sumstat |
The summary statistic that the user wishes to be output. The three choices are |
prob |
The probability associated with the quantile one wishes to calculate. Only
used if |
time.labels |
Labels for the time period axis (e.g., a vector of years). Character vector. |
busterapprox |
Boolean value indicating whether or not the summary statistics
should be computed using the raw posterior distribution values computed via MCMC
( |
burnin |
Number of MCMC iterations to discard from the beginning of the chain. Integer scalar. |
... |
Additional arguments to be passed on to summary. |
The summary statistics are returned in a matrix with rows indexed by time period and
columns indexed by subzone. The body of the matrix is filled with the summary
statistics requested for by the argument sumstat
.
This is a method for objects of class ebhistorical
returned by the function
EpiBayesHistorical
and creates its own class of object much like the
summary method for lm
objects. There is an additional plot method that will
plot the summary output from this method, summary.ebhistorical
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.