alma_events {almanac}

Get all events

Description

alma_events() retrieves all of the events in the rschedule's event set.

Usage

alma_events(rschedule, ..., year = NULL)

Arguments

rschedule

⁠[rschedule]⁠

An rschedule, such as an rrule, runion, rintersect, or rsetdiff.

...

These dots are for future extensions and must be empty.

year

⁠[NULL / integer]⁠

An optional integer vector of years to limit the returned events to.

Value

A Date vector of events.

Examples

rrule <- daily(since = "1970-01-01", until = "1970-01-05")

alma_events(rrule)

on_christmas <- yearly() %>%
  recur_on_month_of_year("Dec") %>%
  recur_on_day_of_month(25)

alma_events(on_christmas, year = c(2020, 2022))