X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FForecast.R;h=a983046198c8d7ef7d4934386f3fa26751d353ef;hb=d2ab47a744d8fb29c03a76a7ca2368dae53f9a57;hp=6036daf6504593809680291f8e53929b5cefb4a3;hpb=102bcfda4afbb5cfee885cbee0f55545624168fd;p=talweg.git diff --git a/pkg/R/Forecast.R b/pkg/R/Forecast.R index 6036daf..a983046 100644 --- a/pkg/R/Forecast.R +++ b/pkg/R/Forecast.R @@ -3,11 +3,11 @@ #' Forecast encapsulation as a list (days where prediction occur) of lists (components). #' #' The private field .pred is a list where each cell contains the predicted variables for -#' a period of time of H<=24 hours, from hour P+1 until P+H, where P+1 is taken right -#' after the end of the period designated by \code{getIndexInData()}. In other terms, -#' \code{forecast$getForecast(i)} return forecasts for \code{data$getSerie(i+1)}. -#' Each cell .pred[[i]] is itself a list containing three slots, as described in the -#' 'field' section. +#' a period of time of H<=24 hours, from hour P until P+H-1, where P == predict_from. +#' \code{forecast$getForecast(i)} output forecasts for +#' \code{data$getSerie(forecast$getIndexInData(i))}. +#' +#' @usage # Forecast$new(dates) #' #' @field .pred List with #' \itemize{