step_cross_correlation: step_cross_correlation

In jkennel/hydrorecipes: Hydrogeology steps

step_cross_correlation

Description

Calculate the autocorrelation function or cross-correlation

Usage

step_cross_correlation(.rec, terms, lag_max = 100, 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.
role	character - the name of the role
...	additional arguments

Value

an updated recipe

Examples

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

dat <- data.frame(x = rnorm(rows),
                  y = as.numeric(1:rows))

frec = recipe(formula = formula, data = dat) |>
 step_cross_correlation(x)

frec = recipe(formula = formula, data = dat) |>
 step_cross_correlation(c(x, y))

jkennel/hydrorecipes documentation built on Jan. 15, 2025, 10:50 p.m.