summary.dm_wavelet: Summarize a dm_wavelet object

View source: R/dm_wavelet.R

summary.dm_waveletR Documentation

Summarize a dm_wavelet object

Description

Summarizes wavelet-analysis results produced by dm_wavelet().

For each analyzed series, the summary reports:

  • the dominant period in hours,

  • the corresponding maximum average wavelet power,

  • the analyzed period range in hours,

  • the detected temporal resolution.

Usage

## S3 method for class 'dm_wavelet'
summary(object, top_n = 3, ...)

Arguments

object

An object of class "dm_wavelet".

top_n

Integer. Number of strongest periods to report per series.

...

Further arguments passed to or from other methods.

Value

An object of class "summary.dm_wavelet".


dendRoAnalyst documentation built on May 20, 2026, 5:07 p.m.