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

diff --git a/pkg/R/computeForecast.R b/pkg/R/computeForecast.R
index 53dbc14..a4a539a 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>
@@ -29,13 +31,12 @@
 #' @examples
 #' ts_data <- system.file("extdata","pm10_mesures_H_loc.csv",package="talweg")
 #' exo_data <- system.file("extdata","meteo_extra_noNAs.csv",package="talweg")
-#' data <- getData(ts_data, exo_data, input_tz="GMT", working_tz="GMT", predict_at=7)
-#' pred <- computeForecast(data, 2200:2230, "Persistence", "Zero",
-#'   memory=500, horizon=12, ncores=1)
+#' data <- getData(ts_data, exo_data, input_tz="GMT", working_tz="GMT",
+#'   predict_at=7, limit=200)
+#' pred <- computeForecast(data, 100:130, "Persistence", "Zero",
+#'   memory=50, 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 +45,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