TODO: unit tests for simil days

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

diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R
index 4f57ba2..2c9a7b7 100644 (file)
--- a/pkg/R/F_Zero.R
+++ b/pkg/R/F_Zero.R
@@ -1,13 +1,17 @@
-#' @include Forecaster.R
-#'
 #' 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).
+#'
+#' @docType class
+#' @format R6 class, inherits Forecaster
+#' @aliases F_Zero
+#'
 ZeroForecaster = R6::R6Class("ZeroForecaster",
        inherit = Forecaster,
 
        public = list(
                predictShape = function(data, today, memory, horizon, ...)
-                       rep(0., horizon)
+                       rep(0, horizon)
        )
 )