reorganize folder

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

diff --git a/pkg/man/Forecast-class.Rd b/pkg/man/Forecast-class.Rd
new file mode 100644 (file)
index 0000000..990890e
--- /dev/null
+++ b/pkg/man/Forecast-class.Rd
@@ -0,0 +1,34 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/Forecast.R
+\docType{class}
+\name{Forecast-class}
+\alias{Forecast}
+\alias{Forecast-class}
+\title{Forecast}
+\description{
+Forecast encapsulation
+}
+\section{Fields}{
+
+\describe{
+\item{\code{pred}}{List with
+\itemize{
+  \item serie: forecasted serie
+  \item params: corresponding list of parameters (weights, neighbors...)
+  \item index: corresponding index in data object
+}}
+}}
+\section{Methods}{
+
+\describe{
+\item{\code{append(new_serie, new_params, new_index)}}{Obtain a new pair (serie, params)}
+
+\item{\code{getIndexInData(index)}}{Get (day) index in data where prediction took place}
+
+\item{\code{getParams(index)}}{Get params at specified index}
+
+\item{\code{getSerie(index)}}{Get serie values at specified index}
+
+\item{\code{initialize(...)}}{Initialize empty Forecast object}
+}}
+