X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FData.R;h=c2222e163ee7536a7d29d21f8769809994a66d72;hb=b58167f0785d6545caf2ed887720344e8ad2acd8;hp=4e16805fa85f2b190b767f0d44d2f2c1de4f5a88;hpb=f17665c7d3da672163779da686d9f4d1ebad31f9;p=talweg.git

diff --git a/pkg/R/Data.R b/pkg/R/Data.R
index 4e16805..c2222e1 100644
--- a/pkg/R/Data.R
+++ b/pkg/R/Data.R
@@ -1,89 +1,121 @@
 #' Data
 #'
-#' Data encapsulation
+#' Data encapsulation as a list (days) of lists (components).
 #'
-#' @field data List of
+#' The private field .data is a list where each cell contains the variables for a period
+#' of time of 24 hours, from time P+1 until P the next day where P is an integer between
+#' 0 and 23. .data[[1]] refers to the first measured data (serie and exogenous
+#' variables): the corresponding times can be accessed through the function
+#' \code{getTime()} below. Each cell .data[[i]] is itself a list containing five slots,
+#' as described in the 'field' section.
+#'
+#' @usage Data$new()
+#'
+#' @field .data[[i]] List of
 #' \itemize{
 #'   \item time: vector of times
-#'   \item serie: centered series
-#'   \item level: corresponding levels
+#'   \item centered_serie: centered serie
+#'   \item level: corresponding level
 #'   \item exo: exogenous variables
-#'   \item exo_hat: predicted exogenous variables
+#'   \item exo_hat: predicted exogenous variables (for next day)
+#' }
+#'
+#' @section Methods:
+#' \describe{
+#' \item{\code{getSize()}}{
+#'   Number of series in dataset.}
+#' \item{\code{getStdHorizon()}}{
+#'   Number of time steps from serie[1] until midnight}
+#' \item{\code{append(time, serie, exo, exo_hat)}}{
+#'   Measured data for given vector of times + exogenous predictions from
+#'   last midgnight.}
+#' \item{\code{getTime(index)}}{
+#'   Times (vector) at specified index.}
+#' \item{\code{getCenteredSerie(index)}}{
+#'   Centered serie at specified index.}
+#' \item{\code{getCenteredSeries(indices)}}{
+#'   Centered series at specified indices (in columns).}
+#' \item{\code{getLevel(index)}}{
+#'   Level at specified index.}
+#' \item{\code{getSerie(index)}}{
+#'   Serie (centered+level) at specified index.}
+#' \item{\code{getSeries(indices)}}{
+#'   Series at specified indices (in columns).}
+#' \item{\code{getExoHat(index)}}{
+#'   Predicted exogenous variables at specified index.}
+#' \item{\code{getExo(index)}}{
+#'   Measured exogenous variables at specified index.}
+#' \item{\code{removeFirst()}}{
+#'   Remove first list element (if truncated).}
+#' \item{\code{removeLast()}}{
+#'   Remove last list element (if truncated).}
 #' }
 #'
 #' @docType class
-#' @importFrom R6 R6Class
+#' @format R6 class
 #'
-#' @export
-Data = R6Class("Data",
+Data = R6::R6Class("Data",
+	private = list(
+		.data = list()
+	),
 	public = list(
-		data = "list",
-		initialize = function(...)
-		{
-			"Initialize empty Data object"
-#TODO: continue from here
-			callSuper(...)
-		},
 		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(time, serie, exo, exo_hat)
 		{
-			"'Standard' horizon, from t+1 to midnight"
-
-			24 - as.POSIXlt( data[[1]]$time[1] )$hour + 1
-		},
-		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)
+			level = mean(serie, na.rm=TRUE)
+			centered_serie = serie - level
+			private$.data[[length(private$.data)+1]] <- list(
+				"time"=time, #H-24 --> H-1
+				"centered_serie"=centered_serie, #at 'time'
+				"level"=level, #at 'time'
+				"exo"=exo, #at 'time' (yersteday 0am to last midnight)
+				"exo_hat"=exo_hat) #today 0am to next midnight
 		},
 		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
 		},
+		getCenteredSeries = function(indices)
+			sapply(indices, function(i) self$getCenteredSerie(i))
+		,
 		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
 		},
+		getSeries = function(indices)
+			sapply(indices, function(i) self$getSerie(i))
+		,
 		getExoHat = function(index)
 		{
-			"Exogeous predictions at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$exo_hat
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$exo_hat
 		},
 		getExo = function(index)
 		{
-			"Exogenous measures at specified index"
-
-			index = dateIndexToInteger(index, .self)
-			data[[index]]$exo
-		}
+			index = dateIndexToInteger(index, self)
+			private$.data[[index]]$exo
+		},
+		removeFirst = function()
+			private$.data <- private$.data[2:length(private$.data)]
+		,
+		removeLast = function()
+			private$.data <- private$.data[1:(length(private$.data)-1)]
 	)
 )