weatherjoin_options: weatherjoin options

In weatherjoin: Join Gridded Weather Data to Event Tables

weatherjoin options

Description

Most users will not need to change package options. Advanced configuration can be controlled via options().

Details

Cache policy

• weatherjoin.cache_max_age_days Cache entries older than this (days) are considered stale (default 60).

• weatherjoin.cache_refresh When to refetch: one of "if_missing", "if_stale", "always" (default "if_missing").

• weatherjoin.cache_match_mode Cache matching mode: "cover" (cached window covers requested) or "exact" (default "cover").

• weatherjoin.cache_param_match Parameter matching for cache reuse: "superset" or "exact" (default "superset").

• weatherjoin.cache_pkg Internal namespace used when cache_scope="user" (default "weatherjoin").

Time splitting and call planning

These options control how sparse time series are split into separate provider calls. They are primarily performance controls; incorrect values will not change the meaning of returned weather values, only how much data is downloaded and cached.

• weatherjoin.split_penalty_hours Gap threshold (hours). Larger values yield fewer, wider time windows (default 72).

• weatherjoin.pad_hours Padding (hours) added to both ends of each planned time window (default 0).

• weatherjoin.max_parts Maximum number of planned time windows per representative location (default 50).

Time construction

• weatherjoin.dummy_hour Hour used when constructing daily timestamps (default 12).

Diagnostics

• weatherjoin.keep_rep_cols If TRUE, keep representative-location diagnostics (rep_lon/rep_lat, distance, elevation) in outputs (default FALSE).

Use withr for temporary changes:

withr::local_options(list(
  weatherjoin.split_penalty_hours = 168,
  weatherjoin.max_parts = 25
))

weatherjoin documentation built on Feb. 4, 2026, 5:11 p.m.