Overview
New features
- New holiday and calendar API and corresponding vignette
vignette("holidays-calendars")(#96): rholiday()creates a new holiday from a holiday name and a rschedule that defines when the holiday occurs. There are a number of pre-created holidays prefixed withhol_*(), such ashol_christmas()andhol_us_thanksgiving(). Holidays are rschedules, so you can use all of thealma_*()functions on them.hol_observe(),hol_offset(), andhol_rename()are three helpers for the holiday API. In particular,hol_observe()tweaks a holiday's _observance date_ to align with when your business actually celebrated that holiday.
Show all changes in 1.0.0Hide the rest of the changes in 1.0.0
rcalendar()bundles multiple holidays together into a calendar. Calendars are similar torunion()s, so you can use all thealma_*()functions on these, but they also come with their own specialized API of functions that start withcal_*(), such ascal_match()to look up the holiday name a date corresponds to, andcal_events()to filter for all of the holidays within a particular year.cal_us_federal()is an example calendar representing the federal holidays recognized in the United States.- New
roffset()for creating an rschedule with events that are offset from an existing rschedule (#94). - New
rcustom()for creating an rschedule from manually defined event dates (#90). alma_events()has gained ayearargument to limit the returned set of events to specific years.runion(),rintersect(), andrsetdiff()have all gained...which allows you to provide rschedules at creation time. This is now the preferred way to create these set-based rschedules (#91).- Steppers created with
stepper()now work as.beforeand.afterarguments ofslider::slide_index()and friends (#80).
Lifecycle changes
- The following functions have been deprecated in favor of more intuitively named alternatives (#83):
recur_on_mday()->recur_on_day_of_month()recur_on_wday()->recur_on_day_of_week()recur_on_yday()->recur_on_day_of_year()recur_on_yweek()->recur_on_week_of_year()recur_on_ymonth()->recur_on_month_of_year()
These functions are being aggressively deprecated and will be removed in the
next minor version of almanac.
- The family of
add_*()functions has been deprecated (#92). add_rschedule()has been deprecated in favor of using the...argument ofrunion(),rintersect(), andrsetdiff()directly.add_rdates()has been deprecated in favor of using a combination ofrunion()andrcustom().add_exdates()has been deprecated in favor of using a combination ofrsetdiff()andrcustom().
These functions are being aggressively deprecated and will be removed in the
next minor version of almanac.
- The
offsetargument ofrecur_on_easter()is deprecated in favor of usingroffset()(#94).
Breaking changes
- All almanac class names are now prefixed with
almanac_*to avoid potential clashes with other packages. - The
recur_with_week_start()argumentwdayhas been renamed today. - The following developer facing functions have been removed because they are either no longer applicable or provided extension mechanisms that are not very useful in practice (#93):
new_rbundle()new_runion()new_rintersect()new_rsetdiff()rbundle_restore()
Bug fixes and minor improvements
recur_for_count()no longer overridesuntil(#95).- New
almanac_since()andalmanac_until()helpers to access the defaultsinceanduntilvalues used for all rules (#95). - Greatly improved the print methods of all almanac classes using cli (#86).
- Updated internal JavaScript rrule library to version 2.7.2 (#82).
- R >=3.5.0 is now required, which is in line with tidyverse standards.
From NEWS.md in the release
Install
Health
CRAN check results are not tracked yet.
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK14 OK2026-03-10
Documentation
- Help pages
- 40 (5 internal)includes a package overview page
- Examples that run
- 100%37 run in a plain check
- Exported functions with examples
- 95%
- Documented parameters
- 96%
- Return-value docs
- 84%
- Help pages citing references
- 0%
Downloads
Repository
Last recorded for this package on 2026-08-16. The package was removed from CRAN on 2026-08-22, so this repository is no longer tracked.
9 development-tooling and community-health practices detected across 5 families in the repository last recorded for this package
Checks last ran against github.com/davisvaughan/almanac on 2026-08-23. The package was removed from CRAN, so this is no longer updated.
Show all practicesHide 1 practice
Dependencies
Code & Tests
People & History
Pick two releases to compare their code metrics.
- archivedRemoved from CRAN2026-08-22issues were not corrected in time
- RR 4.6.0 released · 2026-04-24
- RR 4.5.0 released · 2025-04-11
- RR 4.4.0 released · 2024-04-24
- RR 4.3.0 released · 2023-04-21
- 1.0.02023-04-14 · diff ↗ ·
removed 5 exports
new_rbundle, new_rintersect, new_rsetdiff, new_runion, rbundle_restoreadded 43 exports
almanac_since, almanac_until, cal_add, cal_events, cal_match, cal_names, cal_next, cal_previous, cal_remove, cal_us_federal, hol_christmas, hol_christmas_eve, hol_easter, hol_good_friday, hol_halloween, hol_new_years_day, hol_new_years_eve, hol_observe, hol_offset, hol_rename, hol_st_patricks_day, hol_us_election_day, hol_us_fathers_day, hol_us_independence_day, hol_us_indigenous_peoples_day, hol_us_juneteenth, hol_us_labor_day, hol_us_martin_luther_king_junior_day, hol_us_memorial_day, hol_us_mothers_day and 13 more - RR 4.2.0 released · 2022-04-22
- RR 4.1.0 released · 2021-05-18
- 0.1.12020-05-28 · diff ↗
- 0.1.02020-05-27
- RR 4.0.0 released · 2020-04-24
Package metadata
- First published
- 2020-05-27
- Total releases
- 3 / 6 yrs
- License
- MIT + file LICENSE OSI
- Minimum R
- ≥ 3.5.0
- Download size
- 176 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("almanac")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-24, which the citation names so these numbers can be found later. More on citing and the projects behind them.