X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FData.R;h=d970f7b825ad6af4e5e57b16f84a1cb2024ce5b3;hb=25b75559e2d9bf84e2de35b851d93fefdae36e17;hp=18c67dd0f7c193ca1bba301307346b589b047a86;hpb=35eb1443d0ae161c730e371e08e576754ec0084d;p=talweg.git diff --git a/pkg/R/Data.R b/pkg/R/Data.R index 18c67dd..d970f7b 100644 --- a/pkg/R/Data.R +++ b/pkg/R/Data.R @@ -15,83 +15,117 @@ #' @importFrom R6 R6Class #' #' @export -Data = R6Class("Data", +Data = R6::R6Class("Data", private = list( - .data = "list" + .data = list() ), public = list( - initialize = function(...) - initialize(self, private, ...) - , getSize = function() - getSize() + getSizeData(private) , getStdHorizon = function() - getStdHorizon(self, private) + getStdHorizonData(private) + , + append = function(new_time, new_centered_serie, new_level, new_exo, new_exo_hat) + appendData(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat) , - append = function(new_time, new_serie, new_level, new_exo_hat, new_exo) - append(self, private, - - data[[length(data)+1]] <<- list("time"=new_time,"serie"=new_serie,"level"=new_level, - "exo_hat"=new_exo_hat,"exo"=new_exo) - }, getTime = function(index) - { - "Time values at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$time - }, + getTimeData(self, private, index) + , getCenteredSerie = function(index) - { - "Serie values (centered) at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$serie - }, + getCenteredSerieData(self, private, index) + , getLevel = function(index) - { - "Level of the serie at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$level - }, + getLevelData(self, private, index) + , getSerie = function(index) - { - "Serie values (centered+level) at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$serie + data[[index]]$level - }, - getExoHat = function(index) - { - "Exogeous predictions at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$exo_hat - }, + getSerieData(self, private, index) + , getExo = function(index) - { - "Exogenous measures at specified index" - - index = dateIndexToInteger(index, .self) - data[[index]]$exo - } + getExoData(self, private, index) + , + getExoHat = function(index) + getExoHatData(self, private, index) ) ) -#' Initialize empty Data object -initialize = function(self, private, ...) -{ - invisible(self) -} - #' Number of series in the dataset -getSize = function(self, private) +#' +#' @param private List of private members in current object +getSizeData = function(private) length(private$.data) #' 'Standard' horizon, from t+1 to midnight -getStdHorizon = function(self, private) +#' +#' @inheritParams getSizeData +getStdHorizonData = function(private) 24 - as.POSIXlt( private$.data[[1]]$time[1] )$hour + 1 #' Acquire a new vector of lists (time, centered_serie, level, exo, exo_hat) +#' +#' @inheritParams getSizeData +#' @param new_time Time +#' @param new_centered_serie Centered serie +#' @param new_level Level +#' @param new_exo Exogneous variables +#' @param new_exo_hat Predicted exogenous variables +appendData = function(private, new_time, new_centered_serie, new_level, new_exo, new_exo_hat) +{ + private$.data[[length(private$.data)+1]] <- list("time"=new_time, + "centered_serie"=new_centered_serie,"level"=new_level,"exo"=new_exo,"exo_hat"=new_exo_hat) +} + +#' Time values at specified index +#' +#' @inheritParams getSizeData +#' @param index Return value at this index +getTimeData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$time +} + +#' Centered serie values at specified index +#' +#' @inheritParams getTimeData +getCenteredSerieData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$centered_serie +} + +#' Level of the serie at specified index +#' +#' @inheritParams getTimeData +getLevelData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$level +} + +#' Serie values (centered+level) at specified index +#' +#' @inheritParams getTimeData +getSerieData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$centered_serie + data[[index]]$level +} + +#' Exogenous measures at specified index +#' +#' @inheritParams getTimeData +getExoData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$exo +} + +#' Exogeous predictions at specified index +#' +#' @inheritParams getTimeData +getExoHatData = function(o, private, index) +{ + index = dateIndexToInteger(index, o) + private$.data[[index]]$exo_hat +}