X-Git-Url: https://git.auder.net/?p=talweg.git;a=blobdiff_plain;f=pkg%2FR%2FF_Persistence.R;h=eaeca985f303a202fdcd84e9a21257cbe7534e27;hp=754df07b18cde688641e38eb2ad07469ad26fe48;hb=102bcfda4afbb5cfee885cbee0f55545624168fd;hpb=c4c329f65e6e842917cdfbabff36fbca6a617d02

diff --git a/pkg/R/F_Persistence.R b/pkg/R/F_Persistence.R
index 754df07..eaeca98 100644
--- a/pkg/R/F_Persistence.R
+++ b/pkg/R/F_Persistence.R
@@ -1,8 +1,14 @@
 #' Persistence Forecaster
 #'
 #' Look for the most recent similar day in the past, and return its corresponding curve.
-#' "Similar day" means "same day in the week".
 #'
+#' 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
 #' @alias F_Persistence
 #'