get.rege0.prediction: Accessing Subnational Prediction Objects

View source: R/get_outputs.R

get.rege0.predictionR Documentation

Accessing Subnational Prediction Objects


Retrieve subnational (regional) prediction results produced by e0.predict.subnat, either for one country or for all available countries.


get.rege0.prediction(sim.dir, country = NULL, method = "ar1", joint.male = FALSE)



Simulation directory of the subnational predictions. It corresponds to the argument output.dir in e0.predict.subnat.


Numerical country code. If it is not given, all available subnational predictions are retrieved.


Method used for generating the projections. It corresponds to the method argument in e0.predict.subnat.


Logical. If TRUE, the function is applied to a male prediction that was generated using the joint female-male gap model implemented in the function e0.jmale.predict.subnat.


Predictions for country x are assumed to be stored in “sim.dir/subnat_method/cx”.


If argument country is given, the function returns an object of class bayesLife.prediction. If it is NULL, it returns a list of such objects. Names of the list items are the country codes.

See Also



# Subnational example data
my.sube0.file <- file.path(find.package("bayesLife"), 'extdata', 'subnational_e0_template.txt')
sube0 <- read.delim(my.sube0.file, check.names = FALSE)
countries <- unique(sube0[, c("country_code", "country_name")])

# Directory with national projections (contains 30 trajectories for each country)
nat.dir <- file.path(find.package("bayesLife"), "ex-data", "bayesLife.output")

# Subnational projections for all three countries,
# including male projections where female 
# data is used only for demonstration purposes
# (my.e0M.file should contain male e0).
subnat.dir <- tempfile()
e0.predict.subnat(countries$country_code, my.e0.file = my.sube0.file,
    sim.dir = nat.dir, output.dir = subnat.dir, start.year = 2013,
    predict.jmale = TRUE, my.e0M.file = my.sube0.file)
# Retrieve results for all countries
preds <- get.rege0.prediction(subnat.dir)

# View tables of subregions for each country
for(i in 1:nrow(countries)) {
  cat("\n\n", countries$country_name[i], "\n")
# Quantiles for individual subregions for female
e0.trajectories.table(preds[["36"]], "Victoria")

# Retrieve results for one country (Canada)
pred <- get.rege0.prediction(subnat.dir, 124)
e0.trajectories.plot(pred, "Quebec", both.sexes = TRUE)

# Retrieve only male results
predM <- get.rege0.prediction(subnat.dir, 124, joint.male = TRUE)
e0.trajectories.table(predM, "Quebec")

# cleanup

# See more examples in ?e0.predict.subnat

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