X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Average.R;h=72a79f012bdadb91d73deb25c0568a543f48707b;hb=b58167f0785d6545caf2ed887720344e8ad2acd8;hp=a5e3c3e3f47504ad6986d0c5e482fb61eddc24cb;hpb=2057c793ad9929ed5bef8663ea28b896c84df0fc;p=talweg.git

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index a5e3c3e..72a79f0 100644
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,9 +1,18 @@
 #' 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.
+#'
+#' @usage AverageForecaster$new(pjump)
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Average
 #'
-#' @export
 AverageForecaster = R6::R6Class("AverageForecaster",
 	inherit = Forecaster,