add realtime option, slightly refactor data acquisition
[talweg.git] / pkg / R / Forecast.R
index c64d24f..a0ddcda 100644 (file)
 #'   Initialize a Forecast object with a series of date indices.}
 #' \item{\code{getSize()}}{
 #'   Return number of individual forecasts.}
-#' \item{\code{append(new_serie, new_params, new_index_in_data)}}{
-#'   Acquire a new individual forecast, with its (optimized) parameters and the corresponding
-#'   index in the dataset.}
+#' \item{\code{append(forecast, params, index_in_data)}}{
+#'   Acquire an individual forecast, with its (optimized) parameters and the
+#'   corresponding index in the dataset.}
 #' \item{\code{getDates()}}{
 #'   Get dates where forecast occurs.}
-#' \item{\code{getSerie(index)}}{
+#' \item{\code{getForecast(index)}}{
 #'   Get forecasted serie at specified index.}
 #' \item{\code{getParams(index)}}{
 #'   Get parameters at specified index (for 'Neighbors' method).}
@@ -44,19 +44,19 @@ Forecast = R6::R6Class("Forecast",
                getSize = function()
                        length(private$.pred)
                ,
-               append = function(new_serie, new_params, new_index_in_data)
+               append = function(forecast, params, index_in_data)
                {
                        private$.pred[[length(private$.pred)+1]] <-
-                               list("serie"=new_serie, "params"=new_params, "index_in_data"=new_index_in_data)
+                               list("forecast"=forecast, "params"=params, "index_in_data"=index_in_data)
                },
                getDates = function()
                        as.Date( private$.dates, origin="1970-01-01" )
                ,
-               getSerie = function(index)
+               getForecast = function(index)
                {
                        if (is(index,"Date"))
                                index = match(index, private$.dates)
-                       private$.pred[[index]]$serie
+                       private$.pred[[index]]$forecast
                },
                getParams = function(index)
                {