summary-mcmc: Summary Statistics for Life Expectancy MCMCs

summary.bayesLife.mcmc.setR Documentation

Summary Statistics for Life Expectancy MCMCs

Description

Summary of an object bayesLife.mcmc.set or bayesLife.mcmc, computed via run.e0.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.

Usage

## S3 method for class 'bayesLife.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 class 'bayesLife.mcmc'
summary(object, country = NULL,
    par.names = NULL, par.names.cs = NULL, thin = 1, burnin = 0, ...)

Arguments

object

Object of class bayesLife.mcmc.set or bayesLife.mcmc.

country

Country name or code if a country-specific summary is desired. It can also be given as ISO-2 or ISO-3 characters.

chain.id

Identifiers of MCMC chains. By default, all chains are considered.

par.names

Country independent parameters to be included in the summary. Run e0.parameter.names() for defaults.

par.names.cs

Country-specific parameters to be included in the summary. Run e0.parameter.names.cs() for defaults.

meta.only

Logical. If it is TRUE, only meta information of the simulation is included.

thin

Thinning interval. Only used if larger than the thin argument used in run.e0.mcmc.

burnin

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.

Author(s)

Hana Sevcikova

See Also

bayesLife.mcmc.set, summary.mcmc

Examples

sim.dir <- file.path(find.package("bayesLife"), "ex-data", "bayesLife.output")
m <- get.e0.mcmc(sim.dir)
summary(m, country="Czechia", burnin=20)

# names and codes of countries included
head(get.countries.table(m, iso = TRUE))
# using an ISO code
summary(m, country="MG", burnin=20)

bayesLife documentation built on Sept. 16, 2023, 9:07 a.m.