X-Git-Url: https://git.auder.net/images/pieces/%22%20%20%20VariantRules.getPpath%28board%5Bi%5D%5Bj%5D%29%20%20%20%22.svg?a=blobdiff_plain;f=pkg%2FR%2FForecast.R;h=ff7fb8d0bc42138aa43a7cfc32a1c5156019dbeb;hb=aa5397f16be60b338e303b26cfceb65defac3054;hp=2bc77c698d0b1d75ee25165cc21a9fa6424a04b0;hpb=b58167f0785d6545caf2ed887720344e8ad2acd8;p=talweg.git diff --git a/pkg/R/Forecast.R b/pkg/R/Forecast.R index 2bc77c6..ff7fb8d 100644 --- a/pkg/R/Forecast.R +++ b/pkg/R/Forecast.R @@ -3,13 +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-P+1<=24 hours, from hour P until H, where P == predict_from. +#' \code{forecast$getForecast(i)} output forecasts for +#' \code{data$getSerie(forecast$getIndexInData(i))}. #' -#' @usage Forecast$new(dates) +#' @usage # Forecast$new(dates) #' #' @field .pred List with #' \itemize{