X-Git-Url: https://git.auder.net/img/rock_paper_scissors_lizard_spock.gif?a=blobdiff_plain;f=pkg%2FR%2FF_Average.R;h=a1f29ad19a36a98a5695265debe3c75d3171658f;hb=689aa1d3c58e8b1e9fdfa9b895ca38c7228f56cc;hp=d7febd44dcafb0435a788970bea5dd93f721d49a;hpb=c4c329f65e6e842917cdfbabff36fbca6a617d02;p=talweg.git

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index d7febd4..a1f29ad 100644
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,9 +1,17 @@
 #' Average Forecaster
 #'
-#' Pointwise average of all series of the same (day of week) days in the past.
+#' 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 f <- AverageForecaster$new(pjump)
+#'
+#' @docType class
 #' @format R6 class, inherits Forecaster
-#' @alias F_Average
+#' @aliases F_Average
 #'
 AverageForecaster = R6::R6Class("AverageForecaster",
 	inherit = Forecaster,