X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FJ_Persistence.R;h=9e56742680a3db4702cb535a98f5aabdadbcfded;hb=3ddf1c12af0c167fe7d3bb59e63258550270cfc5;hp=a85a42a88ce76089d78491eae45c2d42d9ea6e25;hpb=2057c793ad9929ed5bef8663ea28b896c84df0fc;p=talweg.git

diff --git a/pkg/R/J_Persistence.R b/pkg/R/J_Persistence.R
index a85a42a..9e56742 100644
--- a/pkg/R/J_Persistence.R
+++ b/pkg/R/J_Persistence.R
@@ -1,8 +1,15 @@
-#' Obtain jump forecast by the Persistence method
+#' getPersistenceJumpPredict
+#'
+#' Analog of the PersistenceForecaster: predict the jump after last observed value either
+#' by re-applying the last jump between similar day and its follower (if argument
+#' "same_day" is TRUE), or by re-using the very last observed jump (when "same_day" =
+#' FALSE).
 #'
 #' @inheritParams computeForecast
 #' @inheritParams getZeroJumpPredict
 #'
+#' @aliases J_Persistence
+#'
 getPersistenceJumpPredict = function(data, today, memory, horizon, params, ...)
 {
 	#return gap between end of similar day curve and first day of tomorrow (in the past)