X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Persistence.R;h=3eefa5b07447501aa751174e93d79cf8c73a7a0e;hb=689aa1d3c58e8b1e9fdfa9b895ca38c7228f56cc;hp=220e04cfa9e279cff66ed47c9b505dbcbef562e9;hpb=98e958cab563866f8e00886b54336018a2e8bc97;p=talweg.git

diff --git a/pkg/R/F_Persistence.R b/pkg/R/F_Persistence.R
index 220e04c..3eefa5b 100644
--- a/pkg/R/F_Persistence.R
+++ b/pkg/R/F_Persistence.R
@@ -1,9 +1,19 @@
-#' @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).
+#'
+#' @usage f <- PersistenceForecaster$new(pjump)
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Persistence
+#'
 PersistenceForecaster = R6::R6Class("PersistenceForecaster",
 	inherit = Forecaster,