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

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index dab156a..72a79f0 100644
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,19 +1,23 @@
-#' @include Forecaster.R
+#' Average Forecaster
 #'
-#' @title Average Forecaster
+#' Pointwise average of all the series of the same day of week in the past.
 #'
-#' @description Return the (pointwise) average of the all the (similar) centered day curves
-#'   in the past. Inherits \code{\link{Forecaster}}
-AverageForecaster = setRefClass(
-	Class = "AverageForecaster",
-	contains = "Forecaster",
+#' 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,
 
-	methods = list(
-		initialize = function(...)
-		{
-			callSuper(...)
-		},
-		predictShape = function(today, memory, horizon, ...)
+	public = list(
+		predictShape = function(data, today, memory, horizon, ...)
 		{
 			avg = rep(0., horizon)
 			first_day = max(1, today-memory)