check_gradient: Validation by gradient

In dleutnant/m181: Timeseries Data Validation according to the DWA-M 181

Description

Validates timeseries data by computing the gradients (absolute or relative) of consecutive data points. The output is an xts-object with logical values. TRUE indicates plausible gradients, FALSE represents gradients which exceed the threshold delta_max.

Usage

check_gradient(xts, delta_max, relative = FALSE, lag = 1, verbose = TRUE)

Arguments

xts	An xts object to be validated.
delta_max	The treshold of gradient. Computed gradients lower than delta_max are considered tolerable, higher ones are doubtful.
relative	logical. Should the gradients computed absolute (|x_i - x_i-1|) or relative ((|x_i - x_i-1|)/x_i)?
lag	An integer indicating which lag to use.
verbose	logical. Provide additional details?

References

DWA (2011). Merkblatt DWA-M 181 - Messung von Wasserstand und Durchfluss in Entwaesserungssystemen. Hennef.

See Also

xts, diff.

dleutnant/m181 documentation built on May 15, 2019, 9:16 a.m.