TODO: unit tests for simil days

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

diff --git a/pkg/R/F_Persistence.R b/pkg/R/F_Persistence.R
index 79cfe3c..fa5f99f 100644 (file)
--- a/pkg/R/F_Persistence.R
+++ b/pkg/R/F_Persistence.R
@@ -1,9 +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.
+#'
+#' There are two variations, depending whether "similar day" means "same day in the week"
+#' or "most recent day" (regardless of day type). The corresponding argument is named
+#' "same_day": a value of TRUE implies the former interpretation (same day in week).
+#' If the last similar day has missing values, the next one is searched, and so on until
+#' one full serie is found (if no one is found, NA is returned).
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Persistence
 #'
 PersistenceForecaster = R6::R6Class("PersistenceForecaster",
        inherit = Forecaster,
@@ -14,14 +21,12 @@ PersistenceForecaster = R6::R6Class("PersistenceForecaster",
                        # Return centered last (similar) day curve, avoiding NAs until memory is run
                        first_day = max(1, today-memory)
                        same_day = ifelse(hasArg("same_day"), list(...)$same_day, TRUE)
-                       realtime = ifelse(hasArg("realtime"), list(...)$realtime, FALSE)
                        # If 'same_day', get the last known future of similar day: -7 + 1 == -6
                        index = today - ifelse(same_day,6,0)
                        repeat
                        {
                                {
-                                       last_serie =
-                                               data$getCenteredSerie(index,hat=(index==today && realtime))[1:horizon]
+                                       last_serie = data$getCenteredSerie(index)[1:horizon]
                                        index = index - ifelse(same_day,7,1)
                                };
                                if (!any(is.na(last_serie)))