tfr.predict.extra {bayesTFR} R Documentation

## Generating Posterior Trajectories of the Total Fertility Rate for Specific Countries or Regions

### Description

Using the posterior parameter samples the function generates posterior trajectories of the total fertility rate for given countries or regions. It is intended to be used after running run.tfr.mcmc.extra, but it can be also used for purposes of testing specific settings on one or a few countries.

### Usage

tfr.predict.extra(sim.dir = file.path(getwd(), 'bayesTFR.output'),
prediction.dir = sim.dir, countries = NULL,
save.as.ascii = 0, verbose = TRUE, uncertainty=FALSE,
all.countries.required = TRUE)


### Arguments

 sim.dir Directory with the MCMC simulation results. prediction.dir Directory where the prediction object and the trajectories are stored. countries Vector of country codes for which the prediction should be made. If it is NULL, the prediction is run for all countries that are included in the MCMC object but for which no prediction was generated. save.as.ascii Either a number determining how many trajectories should be converted into an ascii file, or “all” in which case all trajectories are converted. It should be set to 0, if no converions is desired. Note that the convertion is done on all countries. verbose Logical switching log messages on and off. uncertainty Logical. If the MCMC steps considered uncertainty of past TFR and uncertainty=TRUE, starting point of prediction trajectories will be the last estimated trajectories of TFR. Otherwise, it will use the last observed TFR as starting point of prediction. all.countries.required If FALSE it is not required that MCMCs of all countries are present.

### Details

In order to use this function, a prediction object must exist, i.e. the function tfr.predict must have been processed prior to using this function.

Trajectories for given countries or regions are generated and stored in binary format along with other countries (in prediction_dir). The existing prediction object is updated and stored in the same directory. If save.as.ascii is larger than zero, trajectories of ALL countries are converted to an ascii format.

### Value

Updated object of class bayesTFR.prediction.

### Author(s)

Hana Sevcikova

tfr.predict