R/data_reference.R

In dachuwu/TBDtoolbox: The toolbox for Taiwan Burden of Disease

#' @md
#' @title Reference dataset: age distribution of the standard population
#'
#' @details # Variables
#' * `age1`: age group in categorization 1
#' * `percent1`: percentage in population of age group in categorization 1
#' * `age2`: age group in categorization 2
#' * `percent2`: percentage in population of age group in categorization 2
#' * `age3`: age group in categorization 3
#' * `percent3`: percentage in population of age group in categorization 3
#'
#' @family reference datasets
#' @source TBDC
"stand_pop"


#' @md
#' @title Reference dataset: Taiwan population by age, sex, year, region.
#' @details # Variables
#' * `region`: region code, MOI format
#' * `age`: age in 5-year group
#' * `sex`: sex
#' * `year`: year
#' * `population`: population size
#'
#' @family reference datasets
"TWpop_region"



#' @md
#' @title Reference dataset: Taiwan population by age, sex, year, city
#' @details # Variables
#' * `city`: city code, MOI format
#' * `age`: age in 5-year group
#' * `sex`: sex
#' * `year`: year
#' * `population`: population size
#' @family reference datasets
"TWpop_city"



#' @md
#' @title Reference dataset: Taiwan population by age, sex, year, township
#' @details # Variables
#' * `town`:town code, MOI format
#' * `age`: age in 5-year group
#' * `sex`: sex
#' * `year`: year
#' * `population`: population size
#' @family reference datasets
"TWpop_town"