create_wvar: Create a 'wvar' object

Description Usage Arguments Value

View source: R/wvar.R

Description

Structures elements into a wvar object

Usage

1
create_wvar(obj, decomp, filter, robust, eff, alpha, scales, unit)

Arguments

obj

A matrix with dimensions N x 3 that contains Wavelet Variance, Lower CI, and Upper CI.

decomp

A string that indicates whether to use a "dwt" or "modwt" decomposition.

filter

A string that specifies the type of wavelet filter used in the decomposition.

robust

A boolean that triggers the use of the robust estimate.

eff

A double that indicates the efficiency as it relates to an MLE.

alpha

A double that specifies the significance level which in turn specifies the 1-╬▒ confidence level.

scales

A vec that contains the amount of decomposition performed at each level.

unit

A string that indicates the unit expression of the frequency.

Value

A list with the structure:


wv documentation built on Jan. 17, 2020, 1:07 a.m.