Summary of an object bayesTFR.mcmc.set
or bayesTFR.mcmc
, computed via run.tfr.mcmc
or run.tfr3.mcmc
. It can be obtained either for all countries or for a specific country, and either for all parameters or for specific parameters. The function uses the summary.mcmc
function of the coda package.
# S3 method for bayesTFR.mcmc.set
summary(object, country = NULL, chain.id = NULL,
par.names = NULL, par.names.cs = NULL, meta.only = FALSE,
thin = 1, burnin = 0, …)
# S3 method for bayesTFR.mcmc
summary(object, country = NULL, par.names = NULL, par.names.cs = NULL,
thin = 1, burnin = 0, …)
Object of class bayesTFR.mcmc.set
or bayesTFR.mcmc
.
Country name or code if a country-specific summary is desired. By default, summary for all countries is generated.
Identifiers of MCMC chains. By default, all chains are considered.
Country independent parameters to be included in the summary. If the underlying object is an MCMC of phase II, the default names are given by tfr.parameter.names()
, if it is phase III the names are tfr3.parameter.names()
.
Country-specific parameters to be included in the summary. If the underlying object is an MCMC of phase II, the default names are given by tfr.parameter.names.cs()
, if it is phase III the names are tfr3.parameter.names.cs()
.
If it is TRUE
, only meta information of the simulation is included.
Thinning interval. Only used if larger than the thin
argument used in run.tfr.mcmc
or run.tfr3.mcmc
.
Number of iterations to be discarded from the beginning of each chain before computing the summary.
Additional arguments passed to the summary.mcmc
function of the coda package.
# NOT RUN {
sim.dir <- file.path(find.package("bayesTFR"), "ex-data", "bayesTFR.output")
m <- get.tfr.mcmc(sim.dir)
summary(m, country="Czechia", burnin=15)
# }
Run the code above in your browser using DataLab