recur_for_count {almanac}R Documentation

Control the number of times to recur

Description

recur_for_count() controls the total number of events in the recurrence set. Using recur_for_count() will override the until date of the rule.

Usage

recur_for_count(x, n)

Arguments

x

[rrule]

A recurrence rule.

n

[positive integer(1)]

The number of times to recur for.

Details

Remember that the number of times the occurrence has occurred is counted from the since date! Adjust it as necessary to get your desired results.

Value

An updated rrule.

Examples

# Using the default `since` date
daily_since_epoch_for_5 <- daily() %>% recur_for_count(5)

alma_search("1969-12-31", "1970-01-25", daily_since_epoch_for_5)

# Changing the `since` date
daily_since_2019_for_5 <- daily(since = "2019-01-01") %>% recur_for_count(5)

alma_search("2018-12-31", "2019-01-25", daily_since_2019_for_5)

# In the case of "impossible" dates, such as 2019-02-31 and 2019-04-31 in the
# example below, they are not added to the total count. Only true event
# dates are counted.
on_31_for_5 <- monthly(since = "2019-01-01") %>%
  recur_on_mday(31) %>%
  recur_for_count(5)

alma_search("2019-01-01", "2020-01-01", on_31_for_5)

[Package almanac version 0.1.1 Index]