projects
/
talweg.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improve documentation
[talweg.git]
/
pkg
/
R
/
computeForecast.R
diff --git
a/pkg/R/computeForecast.R
b/pkg/R/computeForecast.R
index
35372b3
..
23ccb04
100644
(file)
--- a/
pkg/R/computeForecast.R
+++ b/
pkg/R/computeForecast.R
@@
-1,8
+1,10
@@
#' Compute forecast
#'
#' 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>
#' @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,19
+36,15
@@
#' memory=500, horizon=12, ncores=1)
#' \dontrun{#Sketch for real-time mode:
#' data <- Data$new()
#' 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 {
#' 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+:
#' # 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,
#' times_from_H+1_yersteday_to_Hnow,
#' PM10_values_of_last_24h,
-#' exogenous_measures_for_yersteday)
-#' pred <- forecaster$predictSerie(data, data$getSize()-1, ...)
+#' exogenous_measures_of_last_24h,
+#' exogenous_predictions_for_next_24h)
+#' pred <- forecaster$predictSerie(data, data$getSize(), ...)
#' #do_something_with_pred
#' }}
#' @export
#' #do_something_with_pred
#' }}
#' @export