Generate A Long-Format Data Frame Of Suite Mortality and Fertility Rates — GetSuiteRates • pacehrh

Generate A Long-Format Data Frame Of Suite Mortality and Fertility Rates

GetSuiteRates(results, rateCategory = .populationRateCategories[1])

Arguments

results: Results structure (as returned by RunExperiments())
rateCategory: Rate type ("femaleFertility" | "maleFertility" | "femaleMortality" | "maleMortality")

Value

Data frame

Examples

if (FALSE) {
results <-
  pacehrh::RunExperiments(
    scenarioName = "MergedModel",
    trials = 20
  )

df <- pacehrh::GetSuiteRates(results, rateCategory = "femaleFertility")
}