X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FData.R;h=42e8c69b1ad0380f50404b1b1572a99cd73f0593;hb=98e958cab563866f8e00886b54336018a2e8bc97;hp=6f82f239b1a1077ab9a41ae434f54b913fd6fb07;hpb=dea7ff860b42b3e246c8fa7ce2fb514561b8bc43;p=talweg.git

diff --git a/pkg/R/Data.R b/pkg/R/Data.R
index 6f82f23..42e8c69 100644
--- a/pkg/R/Data.R
+++ b/pkg/R/Data.R
@@ -1,97 +1,99 @@
-#' @title Data
+#' Data
 #'
-#' @description Data encapsulation
+#' 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_hat: predicted exogenous variables
-#'   \item exo_Dm1: List of measured exogenous variables at day minus 1
-#' }
+#'   \item exo: exogenous variables
+#'   \item exo_hat: predicted exogenous variables}
 #'
-#' @exportClass Data
-#' @export Data
-Data = setRefClass(
-	Class = "Data",
-
-	fields = list(
-		data = "list"
+#' @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{getCenteredSeries(indices)}}{
+#'   Get centered series at specified indices (in columns).}
+#' \item{\code{getLevel(index)}}{
+#'   Get level at specified index.}
+#' \item{\code{getSerie(index)}}{
+#'   Get serie (centered+level) at specified index.}
+#' \item{\code{getSeries(indices)}}{
+#'   Get series at specified indices (in columns).}
+#' \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()
 	),
-
-	methods = list(
-		initialize = function(...)
-		{
-			"Initialize empty Data object"
-
-			callSuper(...)
-		},
+	public = list(
 		getSize = function()
-		{
-			"Number of series in the dataset"
-
-			length(data)
-		},
+			length(private$.data)
+		,
 		getStdHorizon = function()
+			24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1
+		,
+		append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)
 		{
-			"'Standard' horizon, from t+1 to midnight"
-
-			L1 = length(data[[1]]$serie)
-			L2 = length(data[[2]]$serie)
-			if (L1 < L2)
-				L2 - L1
-			else
-				L1
-		},
-		append = function(new_time, new_serie, new_level, new_exo_hat, new_exo)
-		{
-			"Acquire a new vector of lists (time, serie, level, exo_hat, exo)"
-
-			data[[length(data)+1]] <<- list("time"=new_time,"serie"=new_serie,"level"=new_level,
-				"exo_hat"=new_exo_hat,"exo"=new_exo)
+			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)
 		{
-			"Get time values at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$time
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$time
 		},
 		getCenteredSerie = function(index)
 		{
-			"Get serie values (centered) at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$serie
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$centered_serie
 		},
+		getCenteredSeries = function(indices)
+			sapply(indices, function(i) self$getCenteredSerie(i))
+		,
 		getLevel = function(index)
 		{
-			"Get level for the serie at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$level
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$level
 		},
 		getSerie = function(index)
 		{
-			"Get 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)
+		getSeries = function(indices)
+			sapply(indices, function(i) self$getSerie(i))
+		,
+		getExo = function(index)
 		{
-			"Get exogeous predictions at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$exo_hat
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$exo
 		},
-		getExoDm1 = function(index)
+		getExoHat = function(index)
 		{
-			"Get exogenous measures at the 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)]
 	)
 )