X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Zero.R;h=977cba9b8a49337e226cdc0ab0ccba90a0762b3c;hb=102bcfda4afbb5cfee885cbee0f55545624168fd;hp=4f57ba2ae947f9c6a6c0483750e0e8c12c354b09;hpb=98e958cab563866f8e00886b54336018a2e8bc97;p=talweg.git diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R index 4f57ba2..977cba9 100644 --- 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 +#' @alias F_Zero +#' ZeroForecaster = R6::R6Class("ZeroForecaster", inherit = Forecaster, public = list( predictShape = function(data, today, memory, horizon, ...) - rep(0., horizon) + rep(0, horizon) ) )