#' 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.
#'
-#' @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{
#' Get index in data which corresponds to current forecast.}
#' }
#'
+#' @docType class
+#' @format R6 class
+#'
Forecast = R6::R6Class("Forecast",
private = list(
.pred = list(),