X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FcomputeForecast.R;h=23ccb0491ff51dd8d7db06abe587e2aa2fe099b4;hb=102bcfda4afbb5cfee885cbee0f55545624168fd;hp=53dbc148d4166d6ced96f252065754970464a52a;hpb=c1be989885d1e402569d55a34aef01b57d6aea1c;p=talweg.git

diff --git a/pkg/R/computeForecast.R b/pkg/R/computeForecast.R
index 53dbc14..23ccb04 100644
--- a/pkg/R/computeForecast.R
+++ b/pkg/R/computeForecast.R
@@ -1,8 +1,10 @@
 #' Compute forecast
 #'
-#' Predict time-series curves for the selected days indices (lines in data).
+#' Predict time-series curves ("tomorrows") at the selected days indices ("todays").
+#' This function just runs a loop over all requested indices, and stores the individual
+#' forecasts into a list which is then turned into a Forecast object.
 #'
-#' @param data Object of type \code{Data}, output of \code{getData()}.
+#' @param data Object of class Data, output of \code{getData()}.
 #' @param indices Indices where to forecast (the day after); integers relative to the
 #'   beginning of data, or (convertible to) Date objects.
 #' @param forecaster Name of the main forecaster; more details: ?F_<forecastername>
@@ -34,8 +36,6 @@
 #'   memory=500, horizon=12, ncores=1)
 #' \dontrun{#Sketch for real-time mode:
 #' data <- Data$new()
-#' # Initialize: first day has no predictions attached
-#' data$initialize()
 #' forecaster <- MyForecaster$new(myJumpPredictFunc)
 #' repeat {
 #'   # In the morning 7am+ or afternoon 1pm+:
@@ -44,7 +44,7 @@
 #'     PM10_values_of_last_24h,
 #'     exogenous_measures_of_last_24h,
 #'     exogenous_predictions_for_next_24h)
-#'   pred <- forecaster$predictSerie(data, data$getSize()-1, ...)
+#'   pred <- forecaster$predictSerie(data, data$getSize(), ...)
 #'   #do_something_with_pred
 #' }}
 #' @export