#'
#' Data encapsulation
#'
-#' @field data List of
-#' \itemize{
+#' @docType class
+#' @importFrom R6 R6Class
+#'
+#' @field .data List of \itemize{
#' \item time: vector of times
#' \item serie: centered series
#' \item level: corresponding levels
#' \item exo: exogenous variables
-#' \item exo_hat: predicted exogenous variables
-#' }
+#' \item exo_hat: predicted exogenous variables}
#'
-#' @docType class
-#' @importFrom R6 R6Class
-#'
-#' @export
-Data = R6Class("Data",
+#' @section Methods: \describe{
+#' \item{\code{getSize()}}
+#' {Return number of series in dataset.}
+#' \item{\code{getStdHorizon()}}
+#' {Return number of time steps from serie[1] until midnight}
+#' \item{\code{append(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)}}
+#' {Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat).}
+#' \item{\code{getTime(index)}}
+#' {Get times at specified index.}
+#' \item{\code{getCenteredSerie(index)}}
+#' {Get centered serie at specified index.}
+#' \item{\code{getLevel(index)}}
+#' {Get level at specified index.}
+#' \item{\code{getSerie(index)}}
+#' {Get serie (centered+level) at specified index.}
+#' \item{\code{getExo(index)}}
+#' {Get exogenous variables at specified index.}
+#' \item{\code{getExoHat(index)}}
+#' {Get estimated exogenous variables at specified index.} }
+Data = R6::R6Class("Data",
private = list(
- .data = "list"
+ .data = list()
),
public = list(
- initialize = function(...)
- initialize(self, private, ...)
- ,
getSize = function()
- getSize()
+ length(private$.data)
,
getStdHorizon = function()
- getStdHorizon(self, private)
+ 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
,
- append = function(new_time, new_serie, new_level, new_exo_hat, new_exo)
- append(self, private,
-
- data[[length(data)+1]] <<- list("time"=new_time,"serie"=new_serie,"level"=new_level,
- "exo_hat"=new_exo_hat,"exo"=new_exo)
+ append = function(
+ {
+ private$.data[[length(private$.data)+1]] <- list(
+ "time"=new_time, "centered_serie"=new_centered_serie, "level"=new_level,
+ "exo"=new_exo, "exo_hat"=new_exo_hat)
},
getTime = function(index)
{
- "Time values at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$time
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$time
},
getCenteredSerie = function(index)
{
- "Serie values (centered) at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$serie
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$centered_serie
},
getLevel = function(index)
{
- "Level of the serie at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$level
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$level
},
getSerie = function(index)
{
- "Serie values (centered+level) at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$serie + data[[index]]$level
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$centered_serie + private$.data[[index]]$level
},
- getExoHat = function(index)
+ getExo = function(index)
{
- "Exogeous predictions at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$exo_hat
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$exo
},
- getExo = function(index)
+ getExoHat = function(index)
{
- "Exogenous measures at specified index"
-
- index = dateIndexToInteger(index, .self)
- data[[index]]$exo
- }
+ index = dateIndexToInteger(index, self)
+ private$.data[[index]]$exo_hat
+ },
+ removeFirst = function()
+ private$.data <- private$.data[2:length(private$.data)]
+ ,
+ removeLast = function()
+ private$.data <- private$.data[1:(length(private$.data)-1)]
)
)
-
-#' Initialize empty Data object
-initialize = function(self, private, ...)
-{
- invisible(self)
-}
-
-#' Number of series in the dataset
-getSize = function(self, private)
- length(private$.data)
-
-#' 'Standard' horizon, from t+1 to midnight
-getStdHorizon = function(self, private)
- 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
-
-#' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat)