on the way back without realtime

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

diff --git a/pkg/R/computeForecast.R b/pkg/R/computeForecast.R
index 198f6ec..1e79118 100644 (file)
--- a/pkg/R/computeForecast.R
+++ b/pkg/R/computeForecast.R
@@ -2,8 +2,9 @@
 #'
 #' Predict time-series curves for the selected days indices (lines in data).
 #'
-#' @param data Dataset, object of type \code{Data} output of \code{getData}
-#' @param indices Days indices where to forecast (the day after)
+#' @param data Object of type \code{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 forcaster
 #' \itemize{
 #'   \item Persistence : use values of last (similar, next) day
@@ -20,8 +21,7 @@
 #' @param memory Data depth (in days) to be used for prediction
 #' @param horizon Number of time steps to predict
 #' @param ncores Number of cores for parallel execution (1 to disable)
-#' @param ... Additional parameters for the forecasting models;
-#'   In particular, realtime=TRUE to use predictions instead of measurements
+#' @param ... Additional parameters for the forecasting models
 #'
 #' @return An object of class Forecast
 #'