errcheck_wavparam: Error check wavelet transform parameters

Description Usage Arguments Value Author(s)

View source: R/errcheck_wavparam.R

Description

Error check the parameters scale.min, scale.max.input, sigma, f0

Usage

1
errcheck_wavparam(scale.min, scale.max.input, sigma, f0, times, callfunc)

Arguments

scale.min

The smallest scale of fluctuation that will be examined. At least 2.

scale.max.input

The largest scale of fluctuation that is guaranteed to be examined

sigma

The ratio of each time scale examined relative to the next timescale. Should be greater than 1.

f0

The ratio of the period of fluctuation to the width of the envelope. Defaults to 1.

times

The times data were measured at, spacing 1

callfunc

Function calling this one, for better error messaging

Value

errcheck_wavparam returns nothing but throws and error if the conditions are not met

Author(s)

Daniel Reuman, reuman@ku.edu


wsyn documentation built on Jan. 15, 2021, 3:37 p.m.