calendar-locations: Calendar locations

In almanac: Tools for Working with Recurrence Rules

Calendar locations

Description

• cal_next() generates the next holiday after x.

• cal_previous() generates the previous holiday before x.

If no holiday exists before/after x, a missing row is generated.

Usage

cal_next(x, rcalendar, ..., inclusive = FALSE)

cal_previous(x, rcalendar, ..., inclusive = FALSE)

Arguments

x	⁠[Date]⁠ A vector of dates.
rcalendar	⁠[rcalendar]⁠ An rcalendar.
...	These dots are for future extensions and must be empty.
inclusive	⁠[logical(1)]⁠ If x is an event, should it be considered the next or previous event?

Value

A two column data frame, like cal_events(), which is the same size as x and contains either the next or previous holiday relative to x.

Examples

x <- as.Date(c("2023-04-11", "2023-08-10", "2021-05-06"))
cal <- cal_us_federal()

cal_next(x, cal)
cal_previous(x, cal)

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