step_kernel_filter: step_kernel_filter

In jkennel/hydrorecipes: Hydrogeology steps

step_kernel_filter

Description

linearly convolve a kernel with a data series.

Usage

step_kernel_filter(
  .rec,
  terms,
  kernel,
  align = "center",
  role = "predictor",
  ...
)

Arguments

.rec	the R6 recipe object.
terms	the unquoted names of the variables to use or a selector function. terms replaces the '...' of the recipes package but requires variables to be included within 'c()'. For example to include variables x and y you would write 'c(x,y)' in the hydrorecipes package.
kernel	the convolution kernel
align	character center, left or right align the convolution
role	character - the name of the role
...	additional arguments

Value

an updated recipe

Examples

formula <- as.formula(x~y+z)
rows <- 1e4

dat <- data.frame(x = rep(1, rows),
                  y = 1:rows,
                  z = cumsum(rnorm(rows)))

frec = recipe(formula = formula, data = dat) |>
  step_kernel_filter(z, kernel = list(rep(1, 1001)/1001), align = "center") |>
  plate("tbl")

jkennel/hydrorecipes documentation built on Dec. 24, 2024, 5:38 p.m.