fix package

[talweg.git] / pkg / R / Forecast.R

diff --git a/pkg/R/Forecast.R b/pkg/R/Forecast.R
index bcafd3a..323ebfb 100644 (file)
--- a/pkg/R/Forecast.R
+++ b/pkg/R/Forecast.R
@@ -1,15 +1,23 @@
 #' Forecast
 #'
-#' Forecast encapsulation
+#' Forecast encapsulation as a list (days where prediction occur) of lists (components).
 #'
-#' @docType class
-#' @importFrom R6 R6Class
+#' The private field .pred is a list where each cell contains the predicted variables for
+#' a period of time of H<=24 hours, from hour P+1 until P+H, where P+1 is taken right
+#' after the end of the period designated by \code{getIndexInData()}. In other terms,
+#' \code{forecast$getForecast(i)} return forecasts for \code{data$getSerie(i+1)}.
+#' Each cell .pred[[i]] is itself a list containing three slots, as described in the
+#' 'field' section.
+#'
+#' @usage # Forecast$new(dates)
 #'
-#' @field .pred List with \itemize{
-#'   \item serie: forecasted serie
+#' @field .pred List with
+#' \itemize{
+#'   \item serie: the forecasted serie
 #'   \item params: corresponding list of parameters (weights, neighbors...)
-#'   \item index_in_data: corresponding index in data object}
-#' @field .dates vector of day indices where forcast occurs
+#'   \item index_in_data: corresponding index in data object
+#' }
+#' @field .dates vector of (integer) day indices where forecast occurs
 #'
 #' @section Methods:
 #' \describe{
@@ -17,18 +25,22 @@
 #'   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).}
 #' \item{\code{getIndexInData(index)}}{
 #'   Get index in data which corresponds to current forecast.}
 #' }
+#'
+#' @docType class
+#' @format R6 class
+#'
 Forecast = R6::R6Class("Forecast",
        private = list(
                .pred = list(),
@@ -43,19 +55,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)
                {