work on doc

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

diff --git a/pkg/R/F_Persistence.R b/pkg/R/F_Persistence.R
index 39e043c..754df07 100644 (file)
--- a/pkg/R/F_Persistence.R
+++ b/pkg/R/F_Persistence.R
@@ -1,14 +1,16 @@
-#' @include Forecaster.R
-#'
 #' Persistence Forecaster
 #'
-#' Return the last centered (similar) day curve.
-#' Inherits \code{\link{Forecaster}}
+#' Look for the most recent similar day in the past, and return its corresponding curve.
+#' "Similar day" means "same day in the week".
+#'
+#' @format R6 class, inherits Forecaster
+#' @alias F_Persistence
+#'
 PersistenceForecaster = R6::R6Class("PersistenceForecaster",
-       inherit = "Forecaster",
+       inherit = Forecaster,
 
        public = list(
-               predictShape = function(today, memory, horizon, ...)
+               predictShape = function(data, today, memory, horizon, ...)
                {
                        # Return centered last (similar) day curve, avoiding NAs until memory is run
                        first_day = max(1, today-memory)