include {bayesTFR} R Documentation

## Inclusion Codes

### Description

Data sets containing codes that determine which countries are to be included into a simulation or/and projections.

### Usage

data(include_2022)
data(include_2019)
data(include_2017)
data(include_2015)
data(include_2012)
data(include_2010)


### Format

Data frames containing one record per country or region. It has the following variables:

country_code

Numerical Location Code (3-digit codes following ISO 3166-1 numeric standard) - see https://en.wikipedia.org/wiki/ISO_3166-1_numeric.

include_code

Entries for which include_code=2 are included in the MCMC estimation of the hyperparameters of the model. Entries for which include_code is 1 or 2 are included in the prediction. Entries with 0 are excluded from both.

### Details

In a simulation, an include_* dataset is selected that corresponds to the given wpp.year passed to the function run.tfr.mcmc. It is merged with a tfr dataset from the corresponding wpp package using the country_code column. Thus, the country entries in this dataset should correspond to entries in the tfr dataset.

The package contains also a dataset called ‘my_tfr_template’ (in ‘extdata’ directory) which is a template for user-specified TFR time series. It has the same structure as the tfr dataset, except that most of the columns are optional. The only required column is country_code (see description of the argument my.tfr.file in run.tfr.mcmc).

### Source

Data provided by the United Nations Population Division.

### Examples

data(include_2019)