| 1 | #' @title Data |
| 2 | #' |
| 3 | #' @description Data encapsulation |
| 4 | #' |
| 5 | #' @field data List of |
| 6 | #' \itemize{ |
| 7 | #' \item time: vector of times |
| 8 | #' \item serie: centered series |
| 9 | #' \item level: corresponding levels |
| 10 | #' \item exo_hat: predicted exogenous variables |
| 11 | #' \item exo_Dm1: List of measured exogenous variables at day minus 1 |
| 12 | #' } |
| 13 | #' |
| 14 | #' @exportClass Data |
| 15 | #' @export Data |
| 16 | Data = setRefClass( |
| 17 | Class = "Data", |
| 18 | |
| 19 | fields = list( |
| 20 | data = "list" |
| 21 | ), |
| 22 | |
| 23 | methods = list( |
| 24 | initialize = function(...) |
| 25 | { |
| 26 | "Initialize empty Data object" |
| 27 | |
| 28 | callSuper(...) |
| 29 | }, |
| 30 | getSize = function() |
| 31 | { |
| 32 | length(data) |
| 33 | }, |
| 34 | append = function(new_time, new_serie, new_level, new_exo_hat, new_exo_Dm1) |
| 35 | { |
| 36 | "Acquire a new vector of lists (time, serie, level, exo_hat, exo_Dm1)" |
| 37 | |
| 38 | data[[length(data)+1]] <<- list("time"=new_time,"serie"=new_serie,"level"=new_level, |
| 39 | "exo_hat"=new_exo_hat,"exo_Dm1"=new_exo_Dm1) |
| 40 | }, |
| 41 | getTime = function(index) |
| 42 | { |
| 43 | "Get time values at specified index" |
| 44 | |
| 45 | data[[index]]$time |
| 46 | }, |
| 47 | getCenteredSerie = function(index) |
| 48 | { |
| 49 | "Get serie values (centered) at specified index" |
| 50 | |
| 51 | data[[index]]$serie |
| 52 | }, |
| 53 | getLevel = function(index) |
| 54 | { |
| 55 | "Get level for the serie at specified index" |
| 56 | |
| 57 | data[[index]]$level |
| 58 | }, |
| 59 | getSerie = function(index) |
| 60 | { |
| 61 | "Get serie values (centered+level) at specified index" |
| 62 | |
| 63 | data[[index]]$serie + data[[index]]$level |
| 64 | }, |
| 65 | getExoHat = function(index) |
| 66 | { |
| 67 | "Get exogeous predictions at specified index" |
| 68 | |
| 69 | data[[index]]$exo_hat |
| 70 | }, |
| 71 | getExoDm1 = function(index) |
| 72 | { |
| 73 | "Get exogenous measures the day before specified index" |
| 74 | |
| 75 | data[[index]]$exo_Dm1 |
| 76 | } |
| 77 | ) |
| 78 | ) |