bayesTFR (version 6.1-2)

get.country.object: Accessing Country Information

Description

Function get.country.object returns an object containing country name, code and index. Functions get.countries.table return a data frame containing codes and names of all countries.

Usage

get.country.object(country, meta = NULL, country.table = NULL, index = FALSE)
# S3 method for bayesTFR.mcmc.set
get.countries.table(object, …)
# S3 method for bayesTFR.prediction
get.countries.table(object, …)

Arguments

country

Country name, code or index. If it is an index, the argument index must be set to TRUE.

meta

Object of class bayesTFR.mcmc.meta. If it is not given, the argument country.table must be given.

country.table

A table containing columns “name” and “code” from which the country info can be extracted. Only relevant, if meta is NULL.

index

Logical determining if the argument country is an index.

object

Object of class bayesTFR.mcmc.set or bayesTFR.prediction.

…

Not used.

Value

Function get.country.object returns a list with components:

name

Country name

code

Country code

index

Country index

Function get.countries.table return a data frame with columns code and name.

Details

Given partial information about a country (i.e. having either name or code or index), the function get.country.object returns an object containing all three pieces of information. Only countries are considered that are included in the simulations and predictions. Country index is an internal index used in various components of a bayesTFR.mcmc.meta object.

See Also

country.names

Examples

# NOT RUN {
sim.dir <- file.path(find.package("bayesTFR"), "ex-data", "bayesTFR.output")
m <- get.tfr.mcmc(sim.dir)
# all four calls should give the same answer
get.country.object('China', m$meta)
get.country.object(156, m$meta)
get.country.object(56, m$meta, index=TRUE)
get.country.object(156, NULL, country.table=get.countries.table(m))
# }