CheckRatio: A helper function for FindPeaks

In addisonklinke/rainflow: Extract cyclic features from compressed time series

Description

Checks whether a local minimum or maximum mets the criteria for an important local extrema based on the compression parameter R.

Usage

CheckRatio(ai, R, aMin = NULL, aMax = NULL)

Arguments

ai	Numeric, value at the current location in the time series.
R	Numeric, the compression parameter (greater than 1).
aMin	Numeric, value of the most recent local minimum in the time series.
aMax	Numeric, value of the most recent local maximum in the time series.

Value

Logical indicating whether the criteria (ratio > R) has been met.

Author(s)

Addison Klinke, [e-mail]

Examples

CheckRatio(ai = 6.1, R = 1.2, aMin = 5)   # returns TRUE
CheckRatio(ai = -1.3, R = 1.1, aMax = -1) # returns TRUE

addisonklinke/rainflow documentation built on Aug. 23, 2020, 10:48 a.m.