R/categorize_age_5u1.R

Defines functions categorize_age_5u1

Documented in categorize_age_5u1

#' Create a categorical age column from a converted ager27 column
#'
#' Simply makes more meaningful labels on the age column. Assumes that the age
#' column was created from the convert_ager27() function. Allows for using
#' tidyr::complete() even when some age/year/race combinations have no
#' observations.
#'
#' @param ageu1_column age column created from convert_ager27u1()
#'
#' @return factor
#' @export
#'
#' @examples
#' categorize_age_5u1(c(0, 1, seq(5, 85, 5)))
categorize_age_5u1 <- function(ageu1_column) {
    ## Just categorizes the age column into 5-year bins
    ## so we can use tidyr::complete()
    x <- factor(ageu1_column,
                levels = c(0, 1, seq(5, 85, 5)),
                labels = c("<1", "1-4",
                           paste0(seq(5, 84, 5), "-",
                                  seq(9, 84, 5)), "85+"),
                ordered = TRUE)
    return(x)
}
mkiang/narcan documentation built on Sept. 26, 2024, 7:18 a.m.