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

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