X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FF_Zero.R;h=56bb4a5d4579a845453544d3099f4b66fb68ab2e;hb=4e821712ee4349b08a0ab3f6bcb35a00342ddef4;hp=fdfee838f13159b2a4a9aa25c28cce06d1900a7d;hpb=a66a84b56467194852f2faee15f4725759b24158;p=talweg.git diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R index fdfee83..56bb4a5 100644 --- a/pkg/R/F_Zero.R +++ b/pkg/R/F_Zero.R @@ -1,13 +1,19 @@ -#' @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). +#' +#' @usage # ZeroForecaster$new(pjump) +#' +#' @docType class +#' @format R6 class, inherits Forecaster +#' @aliases F_Zero +#' ZeroForecaster = R6::R6Class("ZeroForecaster", inherit = Forecaster, public = list( - predictShape = function(today, memory, horizon, ...) - rep(0., horizon) + predictShape = function(data, today, memory, horizon, ...) + rep(0, horizon) ) )