summary.ZIPBayes {ZIPBayes} | R Documentation |
Summarizing the trace output from the MCMC algorithm
Description
This function is a method for ZIPBayes
object. It summarize the trace output from the main functions into interesting summary statistics, such as mean, median, confidence interval, and highest density region (HDR),
Usage
## S3 method for class 'ZIPBayes'
## S3 method for class 'ZIPBayes'
summary(object, burnin = 1, thinperiod = 1, confidence.level = 0.95, ...)
Arguments
object |
the “ZIPBayes” object gotten from the main function. |
burnin |
the number of records to be discarded as the early period of MCMC algorithm. Default is 1, meaning the first data point will be discarded when calculating the summary statistics. |
thinperiod |
the number of period in the thining periord. The results will be picked every this number. Default is 1, meaning no thining will be done. See details. |
confidence.level |
the confidence level for the constructed confidence interval. Default is 0.95. |
... |
other arguments passed to the function. |
Details
This function summarizes the tracing results produced by ZIP
, ZIPMErr
, ZIPExt
, and ZIPInt
.
To diminish the influence of the starting values, we generally discard the first portion of each sequence and focus attention on the remaining. The argument burnin
is set to control the number of steps to be discarded.
Another issue that sometimes arises, once approximate convergence has been reached, is whether to thin the sequences by keeping every k
-th simulation draw from each sequence and discarding the rest. The argument thinperiod
is used to set k
here.
Value
ZIPBayes |
a list of summary for each data set. "HDR_LB" and "HDR_UB" respectively respresents the lower and upper bound of the high density region. |
Author(s)
Qihuang Zhang and Grace Y. Yi.
See Also
Examples
## Please see the example in ZIP() function