smooth_godin: Godin Smoother

In SuisunMarshBranch/wqptools: Outlier Detection Working Group Toolbox

Description

Apply a Godin filter to a vector of data.

Usage

smooth_godin(x, increment, kind = c("mean", "max", "min", "median"), ...)

Arguments

x	A vector of values.
increment	A character string defining the expected time increment. this consists of two parts: a numeric value defining the size of the increment, and the units of the increment. Acceptable units are "secs", "mins", "hours", "days", or "weeks".
kind	what values to filter. Default is the original Godin filter which averages the data. Other options are to use the max or min values of each window.
...	Additional arguments to mean(), max(), min(), or median(), depending on the argument kind.

Details

The Godin filter is defined

F = \frac{A_{24}^2}{24^2}\frac{A_{25}}{25}

Value

A vector of same length as x.

SuisunMarshBranch/wqptools documentation built on May 1, 2021, 2:21 a.m.