% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dm_wavelet.R
\name{summary.dm_wavelet}
\alias{summary.dm_wavelet}
\title{Summarize a dm_wavelet object}
\usage{
\method{summary}{dm_wavelet}(object, top_n = 3, ...)
}
\arguments{
\item{object}{An object of class \code{"dm_wavelet"}.}

\item{top_n}{Integer. Number of strongest periods to report per series.}

\item{...}{Further arguments passed to or from other methods.}
}
\value{
An object of class \code{"summary.dm_wavelet"}.
}
\description{
Summarizes wavelet-analysis results produced by \code{dm_wavelet()}.

For each analyzed series, the summary reports:
\itemize{
  \item the dominant period in hours,
  \item the corresponding maximum average wavelet power,
  \item the analyzed period range in hours,
  \item the detected temporal resolution.
}
}
