X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Average.R;h=8a331115960411a8b71e1962168ba0bb309ecd98;hb=102bcfda4afbb5cfee885cbee0f55545624168fd;hp=c28125ef0a8d6d9c64d42037bde6bc9737bf6f3b;hpb=546b0cb65870355a2a2c3705c91418570499d3a6;p=talweg.git

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index c28125e..8a33111 100644
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,9 +1,15 @@
-#' @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
+#' @alias F_Average
 #'
 AverageForecaster = R6::R6Class("AverageForecaster",
 	inherit = Forecaster,