Commit | Line | Data |
---|---|---|
f17665c7 | 1 | #' Data |
3d69ff21 | 2 | #' |
f17665c7 | 3 | #' Data encapsulation |
3d69ff21 | 4 | #' |
a66a84b5 BA |
5 | #' @docType class |
6 | #' @importFrom R6 R6Class | |
7 | #' | |
8 | #' @field .data List of \itemize{ | |
3d69ff21 BA |
9 | #' \item time: vector of times |
10 | #' \item serie: centered series | |
11 | #' \item level: corresponding levels | |
f17665c7 | 12 | #' \item exo: exogenous variables |
a66a84b5 | 13 | #' \item exo_hat: predicted exogenous variables} |
f17665c7 | 14 | #' |
98e958ca BA |
15 | #' @section Methods: |
16 | #' \describe{ | |
17 | #' \item{\code{getSize()}}{ | |
18 | #' Return number of series in dataset.} | |
19 | #' \item{\code{getStdHorizon()}}{ | |
20 | #' Return number of time steps from serie[1] until midnight} | |
21 | #' \item{\code{append(new_time, new_centered_serie, new_level, new_exo, new_exo_hat)}}{ | |
22 | #' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat).} | |
23 | #' \item{\code{getTime(index)}}{ | |
24 | #' Get times at specified index.} | |
25 | #' \item{\code{getCenteredSerie(index)}}{ | |
26 | #' Get centered serie at specified index.} | |
27 | #' \item{\code{getCenteredSeries(indices)}}{ | |
28 | #' Get centered series at specified indices (in columns).} | |
29 | #' \item{\code{getLevel(index)}}{ | |
30 | #' Get level at specified index.} | |
31 | #' \item{\code{getSerie(index)}}{ | |
32 | #' Get serie (centered+level) at specified index.} | |
33 | #' \item{\code{getSeries(indices)}}{ | |
34 | #' Get series at specified indices (in columns).} | |
35 | #' \item{\code{getExo(index)}}{ | |
36 | #' Get exogenous variables at specified index.} | |
37 | #' \item{\code{getExoHat(index)}}{ | |
38 | #' Get estimated exogenous variables at specified index.} | |
39 | #' } | |
25b75559 | 40 | Data = R6::R6Class("Data", |
35eb1443 | 41 | private = list( |
25b75559 | 42 | .data = list() |
35eb1443 | 43 | ), |
f17665c7 | 44 | public = list( |
3d69ff21 | 45 | getSize = function() |
a66a84b5 | 46 | length(private$.data) |
35eb1443 | 47 | , |
e030a6e3 | 48 | getStdHorizon = function() |
a66a84b5 | 49 | 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1 |
35eb1443 | 50 | , |
5d83d815 | 51 | append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat) |
a66a84b5 BA |
52 | { |
53 | private$.data[[length(private$.data)+1]] <- list( | |
54 | "time"=new_time, "centered_serie"=new_centered_serie, "level"=new_level, | |
55 | "exo"=new_exo, "exo_hat"=new_exo_hat) | |
56 | }, | |
3d69ff21 | 57 | getTime = function(index) |
a66a84b5 BA |
58 | { |
59 | index = dateIndexToInteger(index, self) | |
60 | private$.data[[index]]$time | |
61 | }, | |
3d69ff21 | 62 | getCenteredSerie = function(index) |
a66a84b5 BA |
63 | { |
64 | index = dateIndexToInteger(index, self) | |
65 | private$.data[[index]]$centered_serie | |
66 | }, | |
98e958ca BA |
67 | getCenteredSeries = function(indices) |
68 | sapply(indices, function(i) self$getCenteredSerie(i)) | |
69 | , | |
3d69ff21 | 70 | getLevel = function(index) |
a66a84b5 BA |
71 | { |
72 | index = dateIndexToInteger(index, self) | |
73 | private$.data[[index]]$level | |
74 | }, | |
3d69ff21 | 75 | getSerie = function(index) |
a66a84b5 BA |
76 | { |
77 | index = dateIndexToInteger(index, self) | |
78 | private$.data[[index]]$centered_serie + private$.data[[index]]$level | |
79 | }, | |
98e958ca BA |
80 | getSeries = function(indices) |
81 | sapply(indices, function(i) self$getSerie(i)) | |
82 | , | |
1e20780e | 83 | getExo = function(index) |
a66a84b5 BA |
84 | { |
85 | index = dateIndexToInteger(index, self) | |
86 | private$.data[[index]]$exo | |
87 | }, | |
66877df3 | 88 | getExoHat = function(index) |
a66a84b5 BA |
89 | { |
90 | index = dateIndexToInteger(index, self) | |
91 | private$.data[[index]]$exo_hat | |
92 | }, | |
93 | removeFirst = function() | |
94 | private$.data <- private$.data[2:length(private$.data)] | |
95 | , | |
96 | removeLast = function() | |
97 | private$.data <- private$.data[1:(length(private$.data)-1)] | |
3d69ff21 BA |
98 | ) |
99 | ) |