Commit | Line | Data |
---|---|---|
f17665c7 | 1 | #' Data |
3d69ff21 | 2 | #' |
f17665c7 | 3 | #' Data encapsulation |
3d69ff21 | 4 | #' |
a66a84b5 BA |
5 | #' @docType class |
6 | #' @importFrom R6 R6Class | |
7 | #' | |
2057c793 BA |
8 | #' @field .data List of |
9 | #' \itemize{ | |
3d69ff21 | 10 | #' \item time: vector of times |
2057c793 | 11 | #' \item centered_serie: centered series |
3d69ff21 | 12 | #' \item level: corresponding levels |
f17665c7 | 13 | #' \item exo: exogenous variables |
2057c793 BA |
14 | #' \item exo_hat: predicted exogenous variables |
15 | #' } | |
f17665c7 | 16 | #' |
98e958ca BA |
17 | #' @section Methods: |
18 | #' \describe{ | |
19 | #' \item{\code{getSize()}}{ | |
20 | #' Return number of series in dataset.} | |
21 | #' \item{\code{getStdHorizon()}}{ | |
22 | #' Return number of time steps from serie[1] until midnight} | |
2057c793 BA |
23 | #' \item{\code{appendHat(time, exo_hat)}}{ |
24 | #' New estimated exogenous variables + time} | |
72b9c501 BA |
25 | #' \item{\code{append(serie, exo)}}{ |
26 | #' New measured data; call *after* \code{appendHat()}} | |
98e958ca BA |
27 | #' \item{\code{getTime(index)}}{ |
28 | #' Get times at specified index.} | |
2057c793 | 29 | #' \item{\code{getCenteredSerie(index)}}{ |
72b9c501 | 30 | #' Get (measured or predicted) centered serie at specified index.} |
2057c793 | 31 | #' \item{\code{getCenteredSeries(indices)}}{ |
98e958ca | 32 | #' Get centered series at specified indices (in columns).} |
2057c793 | 33 | #' \item{\code{getLevel(index)}}{ |
98e958ca | 34 | #' Get level at specified index.} |
2057c793 | 35 | #' \item{\code{getSerie(index)}}{ |
98e958ca | 36 | #' Get serie (centered+level) at specified index.} |
2057c793 | 37 | #' \item{\code{getSeries(indices)}}{ |
98e958ca | 38 | #' Get series at specified indices (in columns).} |
2057c793 BA |
39 | #' \item{\code{getExoHat(index)}}{ |
40 | #' Get predicted exogenous variables at specified index.} | |
41 | #' \item{\code{getExo(index)}}{ | |
98e958ca | 42 | #' Get exogenous variables at specified index.} |
2057c793 BA |
43 | #' \item{\code{removeFirst()}}{ |
44 | #' Remove first list element (if truncated).} | |
45 | #' \item{\code{removeLast()}}{ | |
46 | #' Remove last list element (if truncated).} | |
98e958ca | 47 | #' } |
546b0cb6 | 48 | #' |
25b75559 | 49 | Data = R6::R6Class("Data", |
35eb1443 | 50 | private = list( |
25b75559 | 51 | .data = list() |
35eb1443 | 52 | ), |
f17665c7 | 53 | public = list( |
3d69ff21 | 54 | getSize = function() |
a66a84b5 | 55 | length(private$.data) |
35eb1443 | 56 | , |
e030a6e3 | 57 | getStdHorizon = function() |
a66a84b5 | 58 | 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1 |
35eb1443 | 59 | , |
2057c793 BA |
60 | appendHat = function(time, exo_hat) |
61 | private$.data[[length(private$.data)+1]] <- list("time"=time,"exo_hat"=exo_hat) | |
62 | , | |
63 | append = function(time, serie, exo) | |
72b9c501 | 64 | { |
2057c793 | 65 | index <- length(private$.data) |
72b9c501 BA |
66 | level = mean(serie, na.rm=TRUE) |
67 | centered_serie = serie - level | |
2057c793 BA |
68 | private$.data[[index]]$time <- time |
69 | private$.data[[index]]$centered_serie <- centered_serie | |
70 | private$.data[[index]]$level <- level | |
71 | private$.data[[index]]$exo <- exo | |
a66a84b5 | 72 | }, |
3d69ff21 | 73 | getTime = function(index) |
a66a84b5 BA |
74 | { |
75 | index = dateIndexToInteger(index, self) | |
76 | private$.data[[index]]$time | |
77 | }, | |
2057c793 | 78 | getCenteredSerie = function(index) |
a66a84b5 BA |
79 | { |
80 | index = dateIndexToInteger(index, self) | |
2057c793 | 81 | private$.data[[index]]$centered_serie |
a66a84b5 | 82 | }, |
2057c793 BA |
83 | getCenteredSeries = function(indices) |
84 | sapply(indices, function(i) self$getCenteredSerie(i)) | |
98e958ca | 85 | , |
2057c793 | 86 | getLevel = function(index) |
a66a84b5 BA |
87 | { |
88 | index = dateIndexToInteger(index, self) | |
2057c793 | 89 | private$.data[[index]]$level |
a66a84b5 | 90 | }, |
2057c793 | 91 | getSerie = function(index) |
a66a84b5 BA |
92 | { |
93 | index = dateIndexToInteger(index, self) | |
2057c793 | 94 | private$.data[[index]]$centered_serie + private$.data[[index]]$level |
a66a84b5 | 95 | }, |
2057c793 BA |
96 | getSeries = function(indices) |
97 | sapply(indices, function(i) self$getSerie(i)) | |
98e958ca | 98 | , |
2057c793 BA |
99 | getExoHat = function(index) |
100 | { | |
101 | index = dateIndexToInteger(index, self) | |
102 | private$.data[[index]]$exo_hat | |
103 | }, | |
104 | getExo = function(index) | |
a66a84b5 BA |
105 | { |
106 | index = dateIndexToInteger(index, self) | |
2057c793 | 107 | private$.data[[index]]$exo |
a66a84b5 BA |
108 | }, |
109 | removeFirst = function() | |
110 | private$.data <- private$.data[2:length(private$.data)] | |
111 | , | |
112 | removeLast = function() | |
113 | private$.data <- private$.data[1:(length(private$.data)-1)] | |
3d69ff21 BA |
114 | ) |
115 | ) |