rbundle-set: Create a new set-based recurrence bundle

Description

Often, a single rrule will be sufficient. However, more complex recurrence objects can be constructed by combining multiple rschedules into a recurrence bundle.

There are three types of recurrence bundles provided in almanac, each of which construct their event sets by performing a set operation on the underlying event sets of the rschedules in the bundle.

runion() takes the union.
rintersect() takes the intersection.
rsetdiff() takes the set difference.

Once you have created a recurrence bundle, you can:

Add recurrence rules or other recurrence bundles with add_rschedule().
Forcibly include dates in its event set with add_rdates().
Forcibly exclude dates from its event set with add_exdates().

Usage

rintersect()
rsetdiff()
runion()

Arguments

Value

An empty rbundle.

Details

For rsetdiff(), the event set is created "from left to right" and depends on the order that the rschedules were added to the bundle.

Examples

Run this code

since <- "2019-04-01"
until <- "2019-05-31"

on_weekends <- weekly(since = since, until = until) %>%
  recur_on_weekends()

on_25th <- monthly(since = since, until = until) %>%
  recur_on_mday(25)

# On weekends OR the 25th of the month
ru <- runion() %>%
  add_rschedule(on_weekends) %>%
  add_rschedule(on_25th)

alma_events(ru)

# On weekends AND the 25th of the month
ri <- rintersect() %>%
  add_rschedule(on_weekends) %>%
  add_rschedule(on_25th)

alma_events(ri)

# On weekends AND NOT the 25th of the month
rsd1 <- rsetdiff() %>%
  add_rschedule(on_weekends) %>%
  add_rschedule(on_25th)

alma_events(rsd1)

# On the 25th of the month AND NOT the weekend
rsd2 <- rsetdiff() %>%
  add_rschedule(on_25th) %>%
  add_rschedule(on_weekends)

alma_events(rsd2)