after merg

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

diff --git a/pkg/R/Forecast.R b/pkg/R/Forecast.R
index 323ebfb..ff7fb8d 100644 (file)
--- a/pkg/R/Forecast.R
+++ b/pkg/R/Forecast.R
@@ -3,11 +3,9 @@
 #' Forecast encapsulation as a list (days where prediction occur) of lists (components).
 #'
 #' 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.
+#' a period of time of H-P+1<=24 hours, from hour P until H, where P == predict_from.
+#' \code{forecast$getForecast(i)} output forecasts for
+#' \code{data$getSerie(forecast$getIndexInData(i))}.
 #'
 #' @usage # Forecast$new(dates)
 #'