work on doc

[talweg.git] / pkg / R / F_Average.R

diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R
index 5058825..d7febd4 100644 (file)
--- a/pkg/R/F_Average.R
+++ b/pkg/R/F_Average.R
@@ -1,14 +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 series of the same (day of week) days in the past.
+#'
+#' @format R6 class, inherits Forecaster
+#' @alias F_Average
+#'
 AverageForecaster = R6::R6Class("AverageForecaster",
        inherit = Forecaster,
 
        public = list(
-               predictShape = function(today, memory, horizon, ...)
+               predictShape = function(data, today, memory, horizon, ...)
                {
                        avg = rep(0., horizon)
                        first_day = max(1, today-memory)
@@ -17,7 +18,7 @@ AverageForecaster = R6::R6Class("AverageForecaster",
                        repeat
                        {
                                {
-                                       serie_on_horizon = private$.data$getCenteredSerie(index)[1:horizon]
+                                       serie_on_horizon = data$getCenteredSerie(index)[1:horizon]
                                        index = index - 7
                                };
                                if (!any(is.na(serie_on_horizon)))