TODO: unit tests for simil days

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

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index 7ec4e90..8f81747 100644 (file)
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,9 +1,16 @@
-#' @include Forecaster.R
-#'
 #' Average Forecaster
 #'
-#' Return the (pointwise) average of the all the (similar) centered day curves
-#' in the past. Inherits \code{\link{Forecaster}}
+#' Pointwise average of all the series of the same day of week in the past.
+#'
+#' For example, if the current day (argument "today") is a tuesday, then all series
+#' corresponding to wednesdays in the past (until the beginning or memory limit) are
+#' averaged to provide a smooth prediction. This forecast will most of the time be wrong,
+#' but will also look plausible enough.
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Average
+#'
 AverageForecaster = R6::R6Class("AverageForecaster",
        inherit = Forecaster,