'update'
[talweg.git] / pkg / R / Forecast.R
1 #' Forecast
2 #'
3 #' Forecast encapsulation
4 #'
5 #' @docType class
6 #' @importFrom R6 R6Class
7 #'
8 #' @field .pred List with \itemize{
9 #' \item serie: forecasted serie
10 #' \item params: corresponding list of parameters (weights, neighbors...)
11 #' \item index_in_data: corresponding index in data object}
12 #' @field .dates vector of day indices where forcast occurs
13 #'
14 #' @section Methods:
15 #' \describe{
16 #' \item{\code{initialize(dates)}}{
17 #' Initialize a Forecast object with a series of date indices.}
18 #' \item{\code{getSize()}}{
19 #' Return number of individual forecasts.}
20 #' \item{\code{append(new_serie, new_params, new_index_in_data)}}{
21 #' Acquire a new individual forecast, with its (optimized) parameters and the corresponding
22 #' index in the dataset.}
23 #' \item{\code{getDates()}}{
24 #' Get dates where forecast occurs.}
25 #' \item{\code{getSerie(index)}}{
26 #' Get forecasted serie at specified index.}
27 #' \item{\code{getParams(index)}}{
28 #' Get parameters at specified index (for 'Neighbors' method).}
29 #' \item{\code{getIndexInData(index)}}{
30 #' Get index in data which corresponds to current forecast.}
31 #' }
32 #'
33 Forecast = R6::R6Class("Forecast",
34 private = list(
35 .pred = list(),
36 .dates = integer(0) #store dates as integers (from 1970-01-01)
37 ),
38 public = list(
39 initialize = function(dates)
40 {
41 private$.dates <- dates
42 invisible(self)
43 },
44 getSize = function()
45 length(private$.pred)
46 ,
47 append = function(new_serie, new_params, new_index_in_data)
48 {
49 private$.pred[[length(private$.pred)+1]] <-
50 list("serie"=new_serie, "params"=new_params, "index_in_data"=new_index_in_data)
51 },
52 getDates = function()
53 as.Date( private$.dates, origin="1970-01-01" )
54 ,
55 getSerie = function(index)
56 {
57 if (is(index,"Date"))
58 index = match(index, private$.dates)
59 private$.pred[[index]]$serie
60 },
61 getParams = function(index)
62 {
63 if (is(index,"Date"))
64 index = match(index, private$.dates)
65 private$.pred[[index]]$params
66 },
67 getIndexInData = function(index)
68 {
69 if (is(index,"Date"))
70 index = match(index, private$.dates)
71 private$.pred[[index]]$index_in_data
72 }
73 )
74 )