X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2FcomputeError.R;h=3aa028fb88282b41a4f55b92545f1de030e8dd94;hb=b58167f0785d6545caf2ed887720344e8ad2acd8;hp=7da103288805fa64d84feecdad8689b60e55de66;hpb=2057c793ad9929ed5bef8663ea28b896c84df0fc;p=talweg.git

diff --git a/pkg/R/computeError.R b/pkg/R/computeError.R
index 7da1032..3aa028f 100644
--- a/pkg/R/computeError.R
+++ b/pkg/R/computeError.R
@@ -1,18 +1,21 @@
 #' Compute error
 #'
-#' Obtain the errors between forecast and data
+#' Compute the errors between forecasted and measured series.
 #'
-#' @param data Dataset, object of class \code{Data} output of \code{getData}
-#' @param pred Forecast object, class \code{Forecast} output of \code{computeForecast}
+#' @param data Object of class \code{Data} output of \code{getData}
+#' @param pred Object of class \code{Forecast} output of \code{computeForecast}
 #' @param horizon Horizon where to compute the error
 #'   (<= horizon used in \code{computeForecast})
 #'
-#' @return A list (abs,MAPE) of lists (day,indices)
+#' @return A list (abs,MAPE) of lists (day,indices). The "indices" slots contain series
+#'   of size L where L is the number of predicted days; i-th value is the averaged error
+#'   (absolute or MAPE) on day i. The "day" slots contain curves of errors, for each time
+#'   step, averaged on the L forecasting days.
 #'
 #' @export
 computeError = function(data, pred, horizon=data$getStdHorizon())
 {
-	L = forecast$getSize()
+	L = pred$getSize()
 	mape_day = rep(0, horizon)
 	abs_day = rep(0, horizon)
 	mape_indices = rep(NA, L)
@@ -21,7 +24,7 @@ computeError = function(data, pred, horizon=data$getStdHorizon())
 	nb_no_NA_data = 0
 	for (i in seq_len(L))
 	{
-		index = forecast$getIndexInData(i)
+		index = pred$getIndexInData(i)
 		serie = data$getSerie(index+1)[1:horizon]
 		forecast = pred$getForecast(i)[1:horizon]
 		if (!any(is.na(serie)) && !any(is.na(forecast)))