reorganize folder

[talweg.git] / pkg / man / Data-class.Rd

diff --git a/pkg/man/Data-class.Rd b/pkg/man/Data-class.Rd
new file mode 100644 (file)
index 0000000..148218a
--- /dev/null
+++ b/pkg/man/Data-class.Rd
@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/Data.R
+\docType{class}
+\name{Data-class}
+\alias{Data}
+\alias{Data-class}
+\title{Data}
+\description{
+Data encapsulation
+}
+\section{Fields}{
+
+\describe{
+\item{\code{data}}{List of
+\itemize{
+  \item time: vector of times
+  \item serie: centered series
+  \item level: corresponding levels
+  \item exo_hat: predicted exogenous variables
+  \item exo_Dm1: List of measured exogenous variables at day minus 1
+}}
+}}
+\section{Methods}{
+
+\describe{
+\item{\code{append(new_time, new_serie, new_level, new_exo_hat, new_exo_Dm1)}}{Acquire a new vector of lists (time, serie, level, exo_hat, exo_Dm1)}
+
+\item{\code{getCenteredSerie(index)}}{Get serie values (centered) at specified index}
+
+\item{\code{getExoDm1(index)}}{Get exogenous measures the day before specified index}
+
+\item{\code{getExoHat(index)}}{Get exogeous predictions at specified index}
+
+\item{\code{getLevel(index)}}{Get level for the serie at specified index}
+
+\item{\code{getSerie(index)}}{Get serie values (centered+level) at specified index}
+
+\item{\code{getSize()}}{Number of series in the dataset}
+
+\item{\code{getStdHorizon()}}{'Standard' horizon, from t+1 to midnight}
+
+\item{\code{getTime(index)}}{Get time values at specified index}
+
+\item{\code{initialize(...)}}{Initialize empty Data object}
+}}
+