projects / talweg.git / blame
| Commit | Line | Data |
|---|---|---|
| 46952971 BA |
1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/Forecast.R | |
| 3 | \docType{class} | |
| 4 | \name{Forecast-class} | |
| 5 | \alias{Forecast} | |
| 6 | \alias{Forecast-class} | |
| 7 | \title{Forecast} | |
| 8 | \description{ | |
| 9 | Forecast encapsulation | |
| 10 | } | |
| 11 | \section{Fields}{ | |
| 12 | ||
| 13 | \describe{ | |
| 14 | \item{\code{pred}}{List with | |
| 15 | \itemize{ | |
| 16 | \item serie: forecasted serie | |
| 17 | \item params: corresponding list of parameters (weights, neighbors...) | |
| 18 | \item index: corresponding index in data object | |
| 19 | }} | |
| 20 | }} | |
| 21 | \section{Methods}{ | |
| 22 | ||
| 23 | \describe{ | |
| 24 | \item{\code{append(new_serie, new_params, new_index)}}{Obtain a new pair (serie, params)} | |
| 25 | ||
| 26 | \item{\code{getIndexInData(index)}}{Get (day) index in data where prediction took place} | |
| 27 | ||
| 28 | \item{\code{getParams(index)}}{Get params at specified index} | |
| 29 | ||
| 30 | \item{\code{getSerie(index)}}{Get serie values at specified index} | |
| 31 | ||
| 32 | \item{\code{initialize(...)}}{Initialize empty Forecast object} | |
| 33 | }} | |
| 34 |