R/off_day.R

In holideh: Working with Canadian Dates

#' Detect non-business days
#'
#' In a vector of dates, detect the non-business days (holiday or weekend).
#'
#' Holiday dates can be obtained using [get_holidays()], [get_province()], or by defining a custom
#' vector of holidays.
#' @name off_day
#' @seealso [is_bizday()]
NULL

#' @param x A vector of dates or date-times. If date-times are supplied, the date component will be
#' extracted.
#' @param holidays A vector of dates that are holidays.
#' @returns A logical vector of length equal to `x`.
#' @rdname off_day
#' @examples
#' library(lubridate)
#'
#' dates <- seq.Date(from = ymd("2025-12-20"), to = ymd("2025-12-31"), by = "1 day")
#' winter_holidays <- ymd(c("2025-12-25", "2025-12-26"))
#'
#' rlang::set_names(is_holiday(dates, holidays = winter_holidays), dates)
#' rlang::set_names(is_weekend(dates), dates)
#' @export
is_holiday <- function(x, holidays) {
  # If x is a datetime, extract the date component
  if (inherits(x, c("POSIXct", "POSIXt"))) {
    x <- lubridate::date(x)
  }

  check_date(holidays)

  x %in% holidays
}

#' @param weekend A character vector of three-letter abbreviations of weekday names indicating days
#' that should be considered a weekend. Acceptable values are: `"Sun"`, `"Mon"`, `"Tue"`, `"Wed"`,
#' `"Thu"`, `"Fri"`, `"Sat"`.
#' @rdname off_day
#' @export
is_weekend <- function(x, weekend = c("Sat", "Sun")) {
  lubridate::wday(x, label = TRUE) %in% weekend
}