calendar-add-remove: Calendar additions and removals

In almanac: Tools for Working with Recurrence Rules

Calendar additions and removals

Description

• cal_add() adds an rholiday to an rcalendar.

• cal_remove() removes an rholiday from an rcalendar by name, either by specifying a character name or an rholiday object with the same name.

Usage

cal_add(x, rholiday)

cal_remove(x, what)

Arguments

x	⁠[rcalendar]⁠ An rcalendar.
rholiday	⁠[rholiday]⁠ An rholiday to add to the rcalendar.
what	⁠[character(1) / rholiday]⁠ The name of a holiday to remove from the rcalendar, or an rholiday object with the corresponding name that you'd like to remove.

Value

A new rcalendar with the holiday added or removed.

Examples

cal <- rcalendar(
  hol_christmas(),
  hol_halloween(),
  hol_new_years_day(),
  hol_us_presidents_day()
)

# Can't forget Easter!
cal %>%
  cal_add(hol_easter())

# Didn't actually need Halloween
cal %>%
  cal_remove(hol_halloween())

# Can remove by name or by object
cal %>%
  cal_remove("Halloween")

almanac documentation built on April 14, 2023, 12:23 a.m.