reorganize folder

[talweg.git] / pkg / man / Forecaster-class.Rd

diff --git a/pkg/man/Forecaster-class.Rd b/pkg/man/Forecaster-class.Rd
new file mode 100644 (file)
index 0000000..b1ffcf4
--- /dev/null
+++ b/pkg/man/Forecaster-class.Rd
@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/Forecaster.R
+\docType{class}
+\name{Forecaster-class}
+\alias{Forecaster}
+\alias{Forecaster-class}
+\title{Forecaster (abstract class)}
+\description{
+Abstract class to represent a forecaster (they all inherit this)
+}
+\section{Fields}{
+
+\describe{
+\item{\code{params}}{List of computed parameters, for post-run analysis (dev)}
+
+\item{\code{data}}{Dataset, object of class Data}
+
+\item{\code{pjump}}{Function: how to predict the jump at day interface ?}
+}}
+\section{Methods}{
+
+\describe{
+\item{\code{initialize(...)}}{Initialize (generic) Forecaster object}
+
+\item{\code{predict(today, memory, horizon, ...)}}{Obtain a new forecasted time-serie}
+}}
+