EstimateDDM: Estimate death registration between two Census years with a...

In jroth-unfpa/SubnationalCRVS: Assess Quality of Demographic Data and Estimate Death Registration Completeness at Subnational Levels

Description

asdf

Usage

EstimateDDM(
  data,
  name.disaggregations,
  name.age,
  name.sex,
  name.males,
  name.females,
  name.population.year1,
  name.population.year2,
  name.year1,
  name.month1,
  name.day1,
  name.year2,
  name.month2,
  name.day2,
  name.national = NULL,
  name.deaths,
  deaths.summed,
  show.age.range.sensitivity = TRUE,
  min.age.in.search = 15,
  max.age.in.search = 75,
  min.number.of.ages = 8,
  exact.ages.to.use = NULL,
  largest.lower.limit.sensitivity = 35,
  smallest.upper.limit.sensitivity = 40,
  life.expectancy.in.open.group = NULL
)

Arguments

data	data frame that contains at least seven columns representing: (1) five-year age groups, (2) sex, (3, 4) population counts collected at two different time points (typically adjacent Census years) (5, 6) dates of two different time points (7) the level of subnational disaggregation in additino to sex (e.g. a geographic unit such as a province/state, a sociodemographic category such as education level, or combinations thereof).
name.disaggregations	Character string providing the name of the variable in 'data' that represents the levels of subnational disaggregation
name.age	Character string providing the name of the variable in 'data' that represents age
name.sex	Character string providing the name of the variable in 'data' that represents sex
name.males	Character string providing the name of the value of 'name.sex' variable that represents males
name.females	Character string providing the name of the value of 'name.sex' variable that represents females
name.population.year1	Character string providing the name of the variable in 'data' that represents the population count in the earlier time point
name.population.year2	Character string providing the name of the variable in 'data' that represents the population count in the later time point
name.year1	Character string providing the name of the variable in 'data' that represents the year of the earlier of the two time periods (e.g. year of the earlier Census)
name.month1	Character string providing the name of the variable in 'data' that represents the month of the earlier of the two time periods (e.g. month of the earlier Census)
name.day1	Character string providing the name of the variable in 'data' that represents the day of the earlier of the two time periods (e.g. day of the earlier Census)
name.year2	Character string providing the name of the variable in 'data' that represents the year of the later of the two time periods (e.g. year of the later Census)
name.month2	Character string providing the name of the variable in 'data' that represents the month of the later of the two time periods (e.g. month of the later Census)
name.day2	Character string providing the name of the variable in 'data' that represents the day of the later of the two time periods (e.g. day of the later Census)
name.national	A character string providing the value of ‘name.disaggregations' variable that indicates national-level results (e.g. "Overall" or "National"). Defaults to NULL, implying 'name.disaggregations' variable in 'data' only includes values for subnational levels. Defaults to NULL#’ @param name.deaths Character string providing the name of the variable in 'data' that represents the total count or annual average count of deaths between the earlier and later time points
deaths.summed	A logical equivalent to the 'deaths.summed' argument of 'DDM::ddm()', which indicates whether 'name.deaths' provides the total count (TRUE) or annual average count (FALSE) of deaths between the two time points
show.age.range.sensitivity	A logical equal to TRUE if the DDM estimates are provided for every possible age range (obeying the 'min.age.in.search', 'max.age.in.search', and 'min.number.of.ages' arguments) and equal to FALSE are only provided for the optimal age range based on the search performed by ddm(). Defaults to TRUE
min.age.in.search	A numeric equivalent to the 'minA' argument of 'DDM:ddm()'. Defaults to 15
max.age.in.search	A numeric equivalent to the 'maxA' argument of 'DDM:ddm()'. Defaults to 75
min.number.of.ages	A numeric equivalent to the 'minAges' argument of 'DDM:ddm()'. Defaults to 8
exact.ages.to.use	A numeric vector equivalent to 'exact.ages'. Defaults to NULL, which feeds the default value of NULL to 'DDM:ddm()'
largest.lower.limit.sensitivity	A numeric the indicates the largest value of 'min.age.in.search' that should be considered in the sensitivity analysis (the smallest one considered will be the one specified originally with 'min.age.in.search'). Defaults to 45
smallest.upper.limit.sensitivity	A numeric the indicates the smallest value of 'max.age.in.search' that should be considered in the sensitivity analysis (the largest one considered will be the one specified originally with 'max.age.in.search'). Defaults to 50
life.expectancy.in.open.group	A numeric equivalent to the 'eOpen' argument of 'DDM:ddm()'. Defaults to NULL

Examples

ddm_results <- EstimateDDM(data=ecuador_five_year_ages, 
                           name.disaggregations="province_name",
                           name.age="age",
                           name.sex="sex",
                           name.males="m",
                           name.females="f",
                           name.population.year1="pop1",
                           name.population.year2="pop2",
                           name.year1="year1"
                           name.month1="month1",
                           name.day1="day1",
                           name.year2="year2",
                           name.month2="month2",
                           name.day2="day2"
                           name.deaths="deaths",
                           deaths.summed=TRUE,
                           min.age.in.search=15,
                           max.age.in.search=75,
                           min.number.of.ages=8,
                           life.expectancy.in.open.group=NULL,
                           exact.ages.to.use=NULL,
                           show.age.range.sensitivity=FALSE)
ddm_results$ddm_estimates                            

jroth-unfpa/SubnationalCRVS documentation built on July 28, 2020, 8:48 p.m.