recur_on_easter: Recur on easter

In almanac: Tools for Working with Recurrence Rules

Recur on easter

Description

recur_on_easter() is a special helper to recur on Easter. Easter is particularly difficult to construct a recurrence rule for.

Usage

recur_on_easter(x, offset = NULL)

Arguments

x	⁠[rrule]⁠ A recurrence rule.
offset	⁠[integer(1)]⁠ Deprecated in favor of using roffset() directly. An offset in terms of a number of days on either side of Easter to recur on. This offset must still fall within the same year, otherwise the date will be silently ignored.

Value

An updated rrule.

Examples

on_easter <- yearly() %>% recur_on_easter()

# Rather than:
if (FALSE) {
on_easter_monday <- yearly() %>% recur_on_easter(1)
}

# Please use:
on_easter_monday <- roffset(on_easter, 1)

alma_search("1999-01-01", "2001-01-01", on_easter)

both <- runion(on_easter, on_easter_monday)

alma_search("1999-01-01", "2001-01-01", both)

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