R/DutchDayDummies.R

In Glender/DutchDayDummies: R-package to create regression dummies for dutch holidays

#' DutchDayDummies: A package for computing regression dummies for dutch holidays.
#'
#' The DutchDayDummies package provides four categories of important functions:
#' official dutch holidays, non-official dutch holidays, vacations, holiday weekends,
#' payment days and helper-functions.
#'
#' @section Official dutch holidays:
#' \code{\link[DutchDayDummies]{newyears_day}} \cr
#' \code{\link[DutchDayDummies]{easter_sunday}} \cr
#' \code{\link[DutchDayDummies]{easter_monday}} \cr
#' \code{\link[DutchDayDummies]{kings_day}} \cr
#' \code{\link[DutchDayDummies]{white_monday}} \cr
#' \code{\link[DutchDayDummies]{white_sunday}} \cr
#' \code{\link[DutchDayDummies]{xmas_day}} \cr
#' \code{\link[DutchDayDummies]{boxing_day}} \cr
#'
#' @section Non-official dutch holidays:
#' \code{\link[DutchDayDummies]{carnival_sunday}} \cr
#' \code{\link[DutchDayDummies]{valentines_day}} \cr
#' \code{\link[DutchDayDummies]{good_friday}} \cr
#' \code{\link[DutchDayDummies]{ramadan}} \cr
#' \code{\link[DutchDayDummies]{remembrance_day}} \cr
#' \code{\link[DutchDayDummies]{liberation_day}} \cr
#' \code{\link[DutchDayDummies]{sugar_feast}} \cr
#' \code{\link[DutchDayDummies]{fathers_day}} \cr
#' \code{\link[DutchDayDummies]{sacrificial_feast}} \cr
#' \code{\link[DutchDayDummies]{prinsjesdag}} \cr
#' \code{\link[DutchDayDummies]{world_animal_day}} \cr
#' \code{\link[DutchDayDummies]{thanksgiving_day}} \cr
#' \code{\link[DutchDayDummies]{halloween}} \cr
#' \code{\link[DutchDayDummies]{st_martins_day}} \cr
#' \code{\link[DutchDayDummies]{black_friday}} \cr
#' \code{\link[DutchDayDummies]{cyber_monday}} \cr
#' \code{\link[DutchDayDummies]{st_nicholas_day}} \cr
#' \code{\link[DutchDayDummies]{newyears_eve}} \cr
#'
#' @section Vacations:
#' \code{\link[DutchDayDummies]{autumn_vacation}} \cr
#' \code{\link[DutchDayDummies]{xmas_vacation}} \cr
#' \code{\link[DutchDayDummies]{spring_vacation}} \cr
#' \code{\link[DutchDayDummies]{may_vacation}} \cr
#' \code{\link[DutchDayDummies]{summer_vacation}} \cr
#'
#' @section Holiday weekends:
#' \code{\link[DutchDayDummies]{xmas_and_boxing_day}} \cr
#' \code{\link[DutchDayDummies]{pentecost_days}} \cr
#' \code{\link[DutchDayDummies]{easter_weekend}} \cr
#'
#' @section Payment Days:
#' \code{\link[DutchDayDummies]{payment_days}} \cr
#'
#' @section Retrieving multiple holidays:\cr
#' \code{\link[DutchDayDummies]{load_all_days}} \cr
#' \code{\link[DutchDayDummies]{official_holidays}} \cr
#' \code{\link[DutchDayDummies]{non_official_holidays}} \cr
#' \code{\link[DutchDayDummies]{holiday_vacations}} \cr
#' \code{\link[DutchDayDummies]{holiday_weekends}} \cr
#'
#' @section Helper functions:
#' \code{\link[DutchDayDummies]{next_holiday}} \cr
#' \code{\link[DutchDayDummies]{seq_days}} \cr
#' \code{\link[DutchDayDummies]{create_dummy}} \cr
#' \code{\link[DutchDayDummies]{nth_weekday_of_a_month}} \cr
#' \code{\link[DutchDayDummies]{get_wday_before_dates}} \cr
#' \code{\link[DutchDayDummies]{ummalqura_algorithm}} \cr
#' \code{\link[DutchDayDummies]{gauss_easter_algorithm}} \cr
#'
#' @docType package
#' @name DutchDayDummies
NULL
#> NULL