pkg/man/Forecaster-class.Rd

   1 % Generated by roxygen2: do not edit by hand
   2 % Please edit documentation in R/Forecaster.R
   3 \docType{class}
   4 \name{Forecaster-class}
   5 \alias{Forecaster}
   6 \alias{Forecaster-class}
   7 \title{Forecaster (abstract class)}
   8 \description{
   9 Abstract class to represent a forecaster (they all inherit this)
  10 }
  11 \section{Fields}{
  12
  13 \describe{
  14 \item{\code{params}}{List of computed parameters, for post-run analysis (dev)}
  15
  16 \item{\code{data}}{Dataset, object of class Data}
  17
  18 \item{\code{pjump}}{Function: how to predict the jump at day interface ?}
  19 }}
  20 \section{Methods}{
  21
  22 \describe{
  23 \item{\code{initialize(...)}}{Initialize (generic) Forecaster object}
  24
  25 \item{\code{predict(today, memory, horizon, ...)}}{Obtain a new forecasted time-serie}
  26 }}
  27