Commit | Line | Data |
---|---|---|
46952971 BA |
1 | % Generated by roxygen2: do not edit by hand |
2 | % Please edit documentation in R/Data.R | |
3 | \docType{class} | |
4 | \name{Data-class} | |
5 | \alias{Data} | |
6 | \alias{Data-class} | |
7 | \title{Data} | |
8 | \description{ | |
9 | Data encapsulation | |
10 | } | |
11 | \section{Fields}{ | |
12 | ||
13 | \describe{ | |
14 | \item{\code{data}}{List of | |
15 | \itemize{ | |
16 | \item time: vector of times | |
17 | \item serie: centered series | |
18 | \item level: corresponding levels | |
19 | \item exo_hat: predicted exogenous variables | |
20 | \item exo_Dm1: List of measured exogenous variables at day minus 1 | |
21 | }} | |
22 | }} | |
23 | \section{Methods}{ | |
24 | ||
25 | \describe{ | |
26 | \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)} | |
27 | ||
28 | \item{\code{getCenteredSerie(index)}}{Get serie values (centered) at specified index} | |
29 | ||
30 | \item{\code{getExoDm1(index)}}{Get exogenous measures the day before specified index} | |
31 | ||
32 | \item{\code{getExoHat(index)}}{Get exogeous predictions at specified index} | |
33 | ||
34 | \item{\code{getLevel(index)}}{Get level for the serie at specified index} | |
35 | ||
36 | \item{\code{getSerie(index)}}{Get serie values (centered+level) at specified index} | |
37 | ||
38 | \item{\code{getSize()}}{Number of series in the dataset} | |
39 | ||
40 | \item{\code{getStdHorizon()}}{'Standard' horizon, from t+1 to midnight} | |
41 | ||
42 | \item{\code{getTime(index)}}{Get time values at specified index} | |
43 | ||
44 | \item{\code{initialize(...)}}{Initialize empty Data object} | |
45 | }} | |
46 |