X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Zero.R;h=dae43e877814bf8c9dc35953d5e6a33310d99f67;hb=689aa1d3c58e8b1e9fdfa9b895ca38c7228f56cc;hp=ac970c47b80fb0e4fd196f444f41abde8fa90b0d;hpb=2057c793ad9929ed5bef8663ea28b896c84df0fc;p=talweg.git

diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R
index ac970c4..dae43e8 100644
--- a/pkg/R/F_Zero.R
+++ b/pkg/R/F_Zero.R
@@ -1,6 +1,13 @@
 #' Zero Forecaster
 #'
-#' Return 0 (and then adjust). Inherits \code{\link{Forecaster}}
+#' Flat prediction: always forecast a serie of zeros.
+#' This serie is then adjusted using the ".pjump" function (see \code{Forecaster} class).
+#'
+#' @usage f <- ZeroForecaster$new(pjump)
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Zero
 #'
 ZeroForecaster = R6::R6Class("ZeroForecaster",
 	inherit = Forecaster,