temporal-aggregate: The temporal processing module

In tidyindex: A Tidy Data Pipeline to Construct, Compare, and Analyse Indexes

The temporal processing module

Description

The temporal processing module is used to aggregate data along the temporal dimension. Current available aggregation recipe includes temporal_rolling_window.

Usage

temporal_aggregate(data, ...)

temporal_rolling_window(
  var,
  scale,
  .before = 0L,
  .step = 1L,
  .complete = TRUE,
  rm.na = TRUE,
  ...
)

Arguments

data	an index table object, see [tidyindex::init()]
...	an temporal processing object of class temporal_agg
var	the variable to aggregate
scale	numeric, the scale (window) of the aggregation
.before, .step, .complete	see slide_dbl
rm.na	logical, whether to remove the first few rows with NAs

Value

an index table object

Examples

tenterfield |>
  init(time = ym) |>
  temporal_aggregate(.agg = temporal_rolling_window(prcp, scale = 12))

# multiple ids (groups), and multiple scales
queensland |>
  dplyr::filter(id %in% c("ASN00029038", "ASN00029127")) |>
  init(id = id, time = ym) |>
  temporal_aggregate(temporal_rolling_window(prcp, scale = c(12, 24)))

tidyindex documentation built on Nov. 16, 2023, 5:08 p.m.