alma_next: Generate the next or previous event

In almanac: Tools for Working with Recurrence Rules

Generate the next or previous event

Description

• alma_next() generates the next event after x.

• alma_previous() generates the previous event before x.

Usage

alma_next(x, rschedule, inclusive = FALSE)

alma_previous(x, rschedule, inclusive = FALSE)

Arguments

x	⁠[Date]⁠ A vector of dates.
rschedule	⁠[rschedule]⁠ An rschedule, such as an rrule, runion, rintersect, or rsetdiff.
inclusive	⁠[logical(1)]⁠ If x is an event, should it be considered the next or previous event?

Value

A Date vector the same size as x.

Examples

on_12th <- monthly() %>% recur_on_day_of_month(12)
on_monday <- weekly() %>% recur_on_day_of_week("Monday")

# On the 12th of the month, or on Mondays
rb <- runion(on_12th, on_monday)

alma_next(c("2019-01-01", "2019-01-11"), rb)
alma_previous(c("2019-01-01", "2019-01-11"), rb)

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