wav_args_wthr: Wavelet Wavethresh Arguments

View source: R/wavcore.R

wav_args_wthrR Documentation

Wavelet Wavethresh Arguments

Description

The main goal of this function is to generate a tibble with combinations of some possible arguments that can be passed to get wavelet-based signal estimation from the function wavethresh::threshold.

Usage

wav_args_wthr(wdlist, thrlist, lr)

Arguments

wdlist

A named list of arguments for wavelet transform by using wavethresh::wd, excluding the data argument.

thrlist

A named list of arguments that can be used in function wavethresh::threshold, excluding the wd argument.

lr

An integer vector which determines the minimum scale level that is thresholded. The maximum scale level is given by wavethresh::nlevelsWT(wd)-1. For example, lr[1] = 3 is equivalent to levels = 3:(nlevelsWT(wd) - 1) in wavethresh::threshold.wd.

Value

S3 objetc of class args_wthr. This object is a list of the following elements:

args_tbl

A tibble with arguments to get wavevel-based signal estimation from
wavethresh::threshold.

nwt_args

A integer vector of length two. The first element is the number of arguments to pass to the function wavethresh::wd, excluding data. The second element is the number of arguments to the wavethresh::threshold function, excluding wd.

See Also

wav_smooth

Examples

wthr_wd <- list(
  filter.number = 1:4,
  family = c("DaubLeAsymm", "DaubExPhase"),
  type = c("wavelet", "station"),
  bc = c("periodic", "symmetric")
)

wthr_thr <- list(
  type = c("soft", "hard"),
  policy = c(
    "universal",
    "sure",
    "BayesThresh", "cv"
  ),
  boundary = c(TRUE, FALSE)
)

wthr_args <- wav_args_wthr(wthr_wd, wthr_thr, 3:5)

nelson16silva/wavcoreinf documentation built on Feb. 17, 2025, 7:10 p.m.