Enumerate the base grid of one or more model years mapped to timeslices

Materialises the calendar on the base datetime grid: one row per grid point of each requested model year, with the timeslice that point belongs to (via datetime_to_timeslice()). The model year spans [year_start(y), year_start(y + 1)) in the calendar's local time (meta$year_start, meta$utc_offset_minutes); with the default metadata that is simply the Gregorian year in tz.

Usage

expand_calendar(x, year, by = NULL, tz = "UTC", alignment = NULL)

Arguments

x

A Calendar.

year

Integer vector – the model year(s) to enumerate.

by

Resolution string passed to seq.POSIXt's by argument ("hour", "day", "15 min", ...). Defaults to the finest of the calendar's timeframes.

tz

Time zone of the returned datetimes. Defaults to "UTC".

alignment

Optional alignment override, as in datetime_to_timeslice().

Value

A data.frame with columns datetime (POSIXct), year (integer, model year) and timeslice (character). Rows where timeslice is NA are grid points the calendar does not cover.

Examples

cal <- calendar_build("m12")
grid <- expand_calendar(cal, year = 2021, by = "day")
nrow(grid)                                  # 365
#> [1] 365
nrow(expand_calendar(cal, 2020, by = "day"))  # 366 (leap year)
#> [1] 366