merge with remote

[epclust.git] / pkg / man / curvesToContribs.Rd

diff --git a/pkg/man/curvesToContribs.Rd b/pkg/man/curvesToContribs.Rd
new file mode 100644 (file)
index 0000000..caa2532
--- /dev/null
+++ b/pkg/man/curvesToContribs.Rd
@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/main.R
+\name{curvesToContribs}
+\alias{curvesToContribs}
+\title{curvesToContribs}
+\usage{
+curvesToContribs(series, wf, ctype)
+}
+\arguments{
+\item{series}{Matrix of series (in rows), of size n x L}
+
+\item{wf}{Wavelet transform filter; see ?wavelets::wt.filter}
+
+\item{ctype}{Type of contribution: "relative" or "absolute" (or any prefix)}
+}
+\value{
+A matrix of size n x log(L) containing contributions in rows
+}
+\description{
+Compute the discrete wavelet coefficients for each series, and aggregate them in
+energy contribution across scales as described in https://arxiv.org/abs/1101.4744v2
+}