Commit | Line | Data |
---|---|---|
f17665c7 | 1 | #' Data |
3d69ff21 | 2 | #' |
102bcfda | 3 | #' Data encapsulation as a list (days) of lists (components). |
3d69ff21 | 4 | #' |
102bcfda BA |
5 | #' The private field .data is a list where each cell contains the variables for a period |
6 | #' of time of 24 hours, from time P+1 until P the next day where P is an integer between | |
7 | #' 0 and 23. .data[[1]] refers to the first measured data (serie and exogenous | |
8 | #' variables): the corresponding times can be accessed through the function | |
9 | #' \code{getTime()} below. Each cell .data[[i]] is itself a list containing five slots, | |
10 | #' as described in the 'field' section. | |
a66a84b5 | 11 | #' |
102bcfda | 12 | #' @field .data[[i]] List of |
2057c793 | 13 | #' \itemize{ |
3d69ff21 | 14 | #' \item time: vector of times |
102bcfda BA |
15 | #' \item centered_serie: centered serie |
16 | #' \item level: corresponding level | |
f17665c7 | 17 | #' \item exo: exogenous variables |
102bcfda | 18 | #' \item exo_hat: predicted exogenous variables (for next day) |
2057c793 | 19 | #' } |
f17665c7 | 20 | #' |
98e958ca BA |
21 | #' @section Methods: |
22 | #' \describe{ | |
23 | #' \item{\code{getSize()}}{ | |
102bcfda | 24 | #' Number of series in dataset.} |
98e958ca | 25 | #' \item{\code{getStdHorizon()}}{ |
102bcfda BA |
26 | #' Number of time steps from serie[1] until midnight} |
27 | #' \item{\code{append(time, serie, exo, exo_hat)}}{ | |
28 | #' Measured data for given vector of times + exogenous predictions from last midgnight. | |
98e958ca | 29 | #' \item{\code{getTime(index)}}{ |
102bcfda | 30 | #' Times (vector) at specified index.} |
2057c793 | 31 | #' \item{\code{getCenteredSerie(index)}}{ |
102bcfda | 32 | #' Centered serie at specified index.} |
2057c793 | 33 | #' \item{\code{getCenteredSeries(indices)}}{ |
102bcfda | 34 | #' Centered series at specified indices (in columns).} |
2057c793 | 35 | #' \item{\code{getLevel(index)}}{ |
102bcfda | 36 | #' Level at specified index.} |
2057c793 | 37 | #' \item{\code{getSerie(index)}}{ |
102bcfda | 38 | #' Serie (centered+level) at specified index.} |
2057c793 | 39 | #' \item{\code{getSeries(indices)}}{ |
102bcfda | 40 | #' Series at specified indices (in columns).} |
2057c793 | 41 | #' \item{\code{getExoHat(index)}}{ |
102bcfda | 42 | #' Predicted exogenous variables at specified index.} |
2057c793 | 43 | #' \item{\code{getExo(index)}}{ |
102bcfda | 44 | #' Measured exogenous variables at specified index.} |
2057c793 BA |
45 | #' \item{\code{removeFirst()}}{ |
46 | #' Remove first list element (if truncated).} | |
47 | #' \item{\code{removeLast()}}{ | |
48 | #' Remove last list element (if truncated).} | |
98e958ca | 49 | #' } |
546b0cb6 | 50 | #' |
102bcfda BA |
51 | #' @docType class |
52 | #' @format R6 class | |
53 | #' | |
25b75559 | 54 | Data = R6::R6Class("Data", |
35eb1443 | 55 | private = list( |
25b75559 | 56 | .data = list() |
35eb1443 | 57 | ), |
f17665c7 | 58 | public = list( |
3d69ff21 | 59 | getSize = function() |
a66a84b5 | 60 | length(private$.data) |
35eb1443 | 61 | , |
e030a6e3 | 62 | getStdHorizon = function() |
a66a84b5 | 63 | 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1 |
35eb1443 | 64 | , |
4f5204f0 | 65 | append = function(time, serie, exo, exo_hat) |
72b9c501 BA |
66 | { |
67 | level = mean(serie, na.rm=TRUE) | |
68 | centered_serie = serie - level | |
4f5204f0 BA |
69 | private$.data[[length(private$.data)+1]] <- list( |
70 | "time"=time, #H-24 --> H-1 | |
71 | "centered_serie"=centered_serie, #at 'time' | |
72 | "level"=level, #at 'time' | |
73 | "exo"=exo, #at 'time' (yersteday 0am to last midnight) | |
74 | "exo_hat"=exo_hat) #today 0am to next midnight | |
a66a84b5 | 75 | }, |
3d69ff21 | 76 | getTime = function(index) |
a66a84b5 BA |
77 | { |
78 | index = dateIndexToInteger(index, self) | |
79 | private$.data[[index]]$time | |
80 | }, | |
2057c793 | 81 | getCenteredSerie = function(index) |
a66a84b5 BA |
82 | { |
83 | index = dateIndexToInteger(index, self) | |
2057c793 | 84 | private$.data[[index]]$centered_serie |
a66a84b5 | 85 | }, |
2057c793 BA |
86 | getCenteredSeries = function(indices) |
87 | sapply(indices, function(i) self$getCenteredSerie(i)) | |
98e958ca | 88 | , |
2057c793 | 89 | getLevel = function(index) |
a66a84b5 BA |
90 | { |
91 | index = dateIndexToInteger(index, self) | |
2057c793 | 92 | private$.data[[index]]$level |
a66a84b5 | 93 | }, |
2057c793 | 94 | getSerie = function(index) |
a66a84b5 BA |
95 | { |
96 | index = dateIndexToInteger(index, self) | |
2057c793 | 97 | private$.data[[index]]$centered_serie + private$.data[[index]]$level |
a66a84b5 | 98 | }, |
2057c793 BA |
99 | getSeries = function(indices) |
100 | sapply(indices, function(i) self$getSerie(i)) | |
98e958ca | 101 | , |
2057c793 BA |
102 | getExoHat = function(index) |
103 | { | |
104 | index = dateIndexToInteger(index, self) | |
105 | private$.data[[index]]$exo_hat | |
106 | }, | |
107 | getExo = function(index) | |
a66a84b5 BA |
108 | { |
109 | index = dateIndexToInteger(index, self) | |
2057c793 | 110 | private$.data[[index]]$exo |
a66a84b5 BA |
111 | }, |
112 | removeFirst = function() | |
113 | private$.data <- private$.data[2:length(private$.data)] | |
114 | , | |
115 | removeLast = function() | |
116 | private$.data <- private$.data[1:(length(private$.data)-1)] | |
3d69ff21 BA |
117 | ) |
118 | ) |