work on doc

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

diff --git a/pkg/R/computeForecast.R b/pkg/R/computeForecast.R
index 35372b3..1d69777 100644 (file)
--- a/pkg/R/computeForecast.R
+++ b/pkg/R/computeForecast.R
@@ -1,6 +1,8 @@
 #' Compute forecast
 #'
-#' Predict time-series curves for the selected days indices (lines in data).
+#' Predict time-series curves for the selected days indices.
+#'
+#' TODO: details
 #'
 #' @param data Object of type \code{Data}, output of \code{getData()}.
 #' @param indices Indices where to forecast (the day after); integers relative to the
@@ -34,18 +36,14 @@
 #'   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 {
-#'   # During the night between days j and j+1:
-#'   data$appendExoHat(exogenous_predictions)
 #'   # In the morning 7am+ or afternoon 1pm+:
-#'   data$setMeasures(
-#'     data$getSize()-1,
+#'   data$append(
 #'     times_from_H+1_yersteday_to_Hnow,
 #'     PM10_values_of_last_24h,
-#'     exogenous_measures_for_yersteday)
+#'     exogenous_measures_of_last_24h,
+#'     exogenous_predictions_for_next_24h)
 #'   pred <- forecaster$predictSerie(data, data$getSize()-1, ...)
 #'   #do_something_with_pred
 #' }}