ceb_eval: Cohort analysis of mean children ever born (CEB)

View source: R/ceb.R

ceb_evalR Documentation

Cohort analysis of mean children ever born (CEB)

Description

Construct estimates of mean CEB in the reference period of childbearing (mean age of childbearing)

Usage

ceb_eval(
  date_svy,
  ages_w,
  pop_w = NULL,
  ceb = NULL,
  mean_ceb = NULL,
  mac = 28,
  location_mac = NULL,
  plot_ceb = TRUE
)

Arguments

date_svy

survey or census date in the format Y-m-d or string in the formats Y, Y-m, Y-m-d

ages_w

women five-year age group starting-ages vector

pop_w

total women matching ages in ages_w

ceb

total children ever born by women age group

mean_ceb

mean children ever born by women age group

mac

mean age at childbearing matching ages in age_w or unique value for all ages, default = 28

location_mac

retrieve MAC from a given location id or name from WPP2019

plot_ceb

dummy variable to return the plot for mean CEB results

Value

data.frame with 2 vectors: reference date of mean children ever born (decimal) and mean children ever born

Examples

## Kenya 1989 census
date_svy <- "1989-08-25"
ages_w <- seq( 40, 75, 5 )
pop_w <- c( 350140, 280920, 230080, 173260, 158140, 111360, 82080, 54220 )
ceb <- c( 2532140, 2151920, 1736540, 1314140, 1143740, 816820, 560520, 371060 )

ceb_eval( date_svy, ages_w, pop_w, ceb, mac = 28, plot_ceb = TRUE )

# Using mac retrieved from WPP2019
ceb_eval( date_svy, ages_w, pop_w, ceb, location_mac = 'Kenya', plot_ceb = TRUE )

josehcms/fertestr documentation built on Oct. 9, 2024, 9:03 p.m.