R/calendar_mgmt.R

Defines functions season_levels assign_weekint

Documented in assign_weekint season_levels

#' Calendar variable management
#' 
#' Functions and objects to manage calendar-related variables (e.g., 
#' week matching, flu season labeling).
#' 
#' Epiweeks are the same as MMWR Weeks: 
#'    https://wwwn.cdc.gov/nndss/document/MMWR_Week_overview.pdf

#' @param epiweek Numeric. An epiweek: [1, 52]
#' @describeIn calendar_mgmt Assign an integer label based on epiweek.
#' @export

assign_weekint <- function(epiweek) {
  out <- I(epiweek %in% 1:17) * (epiweek + 13) + I(epiweek %in% 18:52) * (epiweek - 39)
  as.integer(out)
}

#' @describeIn calendar_mgmt Return a vector of season labels. Standardizes the 
#' assignment of flu season labels (e.g., 2008-09).
#' @export

season_levels <- function() {
  paste(2003:2018, str_extract(2004:2019, "[0-9]{2}$"), sep = "-")
}
jrgant/FluHospPrediction documentation built on May 7, 2023, 10:40 a.m.