detect_ts_min_max_outliers: Detect min-max outliers in time series

View source: R/preparation.R

detect_ts_min_max_outliersR Documentation

Detect min-max outliers in time series

Description

Detect elements of the time series outside a minimum and maximum range. Additionally, with the minSeries and maxSeries arguments, this ranges can be set differently along the period. When using this feature, the timestep of both minSeries and maxSeries need to be resampled to the original frequency of the data time series, applying forward fill if is needed (Remember the time stamps of each time series element always represent the begining of the time step).

Usage

detect_ts_min_max_outliers(data, min, max, minSeries = NULL, maxSeries = NULL)

Arguments

data

<data.frame> describing the input time series whose outliers need to be detected. Time column: 'time', value column: 'value'.

min

<float> describing the minimum value allowed for each element of the time series.

max

<float> describing the maximum value allowed for each element of the time series.

minSeries

<data.frame> defining the time series with minimum allowed values. Time column: 'time', value column: 'value'.

maxSeries

<data.frame> defining the time series with maximum allowed values. Time column: 'time', value column: 'value'.

Value

<data.frame> with boolean values representing whether a item is an outlier, or not.


biggproject/biggr documentation built on Oct. 2, 2024, 11:13 p.m.