get.tfr.prediction: Accessing a Prediction Object
In jasonacollins/bayesTFR1: Bayesian Fertility Projection

Description Usage Arguments Details Value Author(s) See Also Examples

Function get.tfr.prediction retrieves results of a prediction and creates an object of class bayesTFR.prediction. Function has.tfr.prediction checks an existence of such results.

1
2
3

get.tfr.prediction(mcmc = NULL, sim.dir = NULL, mcmc.dir = NULL)

has.tfr.prediction(mcmc = NULL, sim.dir = NULL)

`mcmc`	Object of class `bayesTFR.mcmc.set` used to make the prediction. It must correspond to a Phase II MCMC. If it is `NULL`, the prediction is loaded from directory given by `sim.dir`.
`sim.dir`	Directory where the prediction is stored. It should correspond to the value of the `output.dir` argument used in the `tfr.predict` function. Only relevant if `mcmc` is `NULL`.
`mcmc.dir`	Optional argument to be used only in a special case when the mcmc object contained in the prediction object was estimated in different directory than in the one to which it points to (for example due to moving or renaming the original directory). The argument causes that the mcmc is redirected to the given directory.

If mcmc is not NULL, the search directory is set to mcmc$meta$output.dir. This approach assumes that the prediction was stored in the same directory as the MCMC simulation, i.e. the output.dir argument of the tfr.predict function was set to NULL. If it is not the case, the argument mcmc.dir should be used.

Function has.tfr.prediction returns a logical indicating if a prediction exists for the given mcmc.

Function get.tfr.prediction returns an object of class bayesTFR.prediction.

Hana Sevcikova

bayesTFR.prediction, tfr.predict, summary.bayesTFR.prediction

1
2
3

sim.dir <- file.path(find.package("bayesTFR"), "ex-data", "bayesTFR.output")
pred <- get.tfr.prediction(sim.dir=sim.dir)
summary(pred, country="Canada")