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

\item{...}{Further arguments passed to or from other methods.}
}
\value{
An object of class \code{"summary.dm_wavelet_reconstruct"} with elements:
\describe{
  \item{overview}{One-row summary of the reconstruction object.}
  \item{series_summary}{Per-series summary table.}
  \item{used_periods}{The table of periods actually used in the reconstruction.}
  \item{selection}{The selection settings used for reconstruction.}
}
}
\description{
Summarizes the output of \code{dm_wavelet_reconstruct()}.

For each reconstructed series, the summary reports:
\itemize{
  \item number of observations,
  \item variance of the original series,
  \item variance of the reconstructed component,
  \item variance of the remaining component,
  \item variance of the returned filtered series,
  \item proportion of original variance represented by reconstructed and filtered series,
  \item correlation and \eqn{R^2} between original and reconstructed,
  \item number and range of periods used in reconstruction.
}
}
