From: Benjamin Auder Date: Fri, 7 Apr 2017 14:41:12 +0000 (+0200) Subject: work on doc X-Git-Url: https://git.auder.net/%7B%7B%20asset%28%27mixstore/images/css/pieces/doc/%3C?a=commitdiff_plain;h=c4c329f65e6e842917cdfbabff36fbca6a617d02;p=talweg.git work on doc --- diff --git a/pkg/R/F_Average.R b/pkg/R/F_Average.R index a5e3c3e..d7febd4 100644 --- a/pkg/R/F_Average.R +++ b/pkg/R/F_Average.R @@ -1,9 +1,10 @@ #' Average Forecaster #' -#' Return the (pointwise) average of the all the (similar) centered day curves -#' in the past. Inherits \code{\link{Forecaster}} +#' Pointwise average of all series of the same (day of week) days in the past. +#' +#' @format R6 class, inherits Forecaster +#' @alias F_Average #' -#' @export AverageForecaster = R6::R6Class("AverageForecaster", inherit = Forecaster, diff --git a/pkg/R/F_Neighbors.R b/pkg/R/F_Neighbors.R index 52c2b35..7e0cdd2 100644 --- a/pkg/R/F_Neighbors.R +++ b/pkg/R/F_Neighbors.R @@ -1,7 +1,13 @@ #' Neighbors Forecaster #' -#' Predict tomorrow as a weighted combination of "futures of the past" days. -#' Inherits \code{\link{Forecaster}} +#' Predict next serie as a weighted combination of "futures of the past" days, +#' where days in the past are chosen and weighted according to some similarity measures. +#' See 'details' section. +#' +#' TODO: details. +#' +#' @format R6 class, inherits Forecaster +#' @alias F_Neighbors #' NeighborsForecaster = R6::R6Class("NeighborsForecaster", inherit = Forecaster, diff --git a/pkg/R/F_Persistence.R b/pkg/R/F_Persistence.R index ad83449..754df07 100644 --- a/pkg/R/F_Persistence.R +++ b/pkg/R/F_Persistence.R @@ -1,7 +1,10 @@ #' Persistence Forecaster #' -#' Return the last centered (similar) day curve. -#' Inherits \code{\link{Forecaster}} +#' Look for the most recent similar day in the past, and return its corresponding curve. +#' "Similar day" means "same day in the week". +#' +#' @format R6 class, inherits Forecaster +#' @alias F_Persistence #' PersistenceForecaster = R6::R6Class("PersistenceForecaster", inherit = Forecaster, diff --git a/pkg/R/F_Zero.R b/pkg/R/F_Zero.R index ac970c4..3c46f2c 100644 --- a/pkg/R/F_Zero.R +++ b/pkg/R/F_Zero.R @@ -1,6 +1,9 @@ #' Zero Forecaster #' -#' Return 0 (and then adjust). Inherits \code{\link{Forecaster}} +#' Flat prediction of next series of 'horizon' values. +#' +#' @format R6 class, inherits Forecaster +#' @alias F_Zero #' ZeroForecaster = R6::R6Class("ZeroForecaster", inherit = Forecaster, diff --git a/pkg/R/computeForecast.R b/pkg/R/computeForecast.R index 4bab811..1d69777 100644 --- a/pkg/R/computeForecast.R +++ b/pkg/R/computeForecast.R @@ -1,6 +1,8 @@ #' Compute forecast #' -#' Predict time-series curves for the selected days indices (lines in data). +#' Predict time-series curves for the selected days indices. +#' +#' TODO: details #' #' @param data Object of type \code{Data}, output of \code{getData()}. #' @param indices Indices where to forecast (the day after); integers relative to the