Skip to contents

Register / look up a direct calendar crosswalk

Source: R/map.R
register_calendar_map.Rd

A registered map short-circuits the derivation in calendar_map() or calendar_map_between() (and thereby recast_calendar()) for one pair of resolutions – the table analogue of the functional override in register_calendar_conversion(), for cases where the exact correspondence is known (provably nested calendars, hand-audited crosswalks).

Usage

register_calendar_map(x, from, to, map)

register_calendar_map_between(from, to, map)

get_calendar_map(x, from, to)

get_calendar_map_between(from, to)

Arguments

x

The Calendar the timeframes belong to, or its name.

from, to

For the within-calendar functions, timeframe names of x. For the _between functions, two Calendar objects or their names (meta$name).

map

A data.frame shaped like the corresponding map result: the two label columns named after the timeframes (plus n_from, n_overlap, w, w_from) or after the calendars (plus year, n_from, n_overlap, w). NULL removes a previously registered map.

Value

Invisibly, the registry key. The get_ functions return the registered map (or NULL).

Details

register_calendar_map() and get_calendar_map() handle a pair of timeframes of one calendar; the map is scoped to that calendar, so the same timeframe pair in two calendars does not collide. register_calendar_map_between() and get_calendar_map_between() handle a pair of calendars.

Examples

between <- calendar_map_between(calendar("m12"), calendar("q4"), year = 2021)
register_calendar_map_between("m12", "q4", between)
get_calendar_map_between("m12", "q4")
#>    year m12 q4 n_from n_overlap          w
#> 1  2021 m01 Q1     31        31 0.08493151
#> 2  2021 m02 Q1     28        28 0.07671233
#> 3  2021 m03 Q1     31        31 0.08493151
#> 4  2021 m04 Q2     30        30 0.08219178
#> 5  2021 m05 Q2     31        31 0.08493151
#> 6  2021 m06 Q2     30        30 0.08219178
#> 7  2021 m07 Q3     31        31 0.08493151
#> 8  2021 m08 Q3     31        31 0.08493151
#> 9  2021 m09 Q3     30        30 0.08219178
#> 10 2021 m10 Q4     31        31 0.08493151
#> 11 2021 m11 Q4     30        30 0.08219178
#> 12 2021 m12 Q4     31        31 0.08493151
list_calendar_maps()
#>       key from to
#> 1 m12->q4  m12 q4
register_calendar_map_between("m12", "q4", NULL)   # remove again

cal <- calendar("m12_h24")
within <- calendar_map(cal, "MONTH", "HOUR")
register_calendar_map(cal, "MONTH", "HOUR", within)
identical(get_calendar_map(cal, "MONTH", "HOUR"), within)
#> [1] TRUE
clear_calendar_maps(registry = TRUE)