distantia (version 2.0.0)

f_detrend_linear: Data Transformation: Linear Detrending of Zoo Time Series

Description

Fits a linear model on each column of a zoo object using time as a predictor, predicts the outcome, and subtracts it from the original data to return a detrended time series. This method might not be suitable if the input data is not seasonal and has a clear trend, so please be mindful of the limitations of this function when applied blindly.

Usage

f_detrend_linear(x = NULL, center = TRUE, ...)

Value

zoo object

Arguments

x

(required, zoo object) Zoo time series object to transform.

center

(required, logical) If TRUE, the output is centered at zero. If FALSE, it is centered at the data mean. Default: TRUE

...

(optional, additional arguments) Ignored in this function.

See Also

Other tsl_transformation: f_binary(), f_clr(), f_detrend_difference(), f_detrend_poly(), f_hellinger(), f_list(), f_log(), f_percent(), f_proportion(), f_proportion_sqrt(), f_rescale_global(), f_rescale_local(), f_scale_global(), f_scale_local(), f_trend_linear(), f_trend_poly()

Examples

x <- zoo_simulate(cols = 2)

y <- f_detrend_linear(
  x = x
)

if(interactive()){
  zoo_plot(x)
  zoo_plot(y)
}