work on doc

[talweg.git] / pkg / R / F_Neighbors.R

diff --git a/pkg/R/F_Neighbors.R b/pkg/R/F_Neighbors.R
index c9eda05..7e0cdd2 100644 (file)
--- a/pkg/R/F_Neighbors.R
+++ b/pkg/R/F_Neighbors.R
@@ -1,9 +1,13 @@
-#' @include Forecaster.R
-#'
 #' 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,
@@ -125,7 +129,7 @@ NeighborsForecaster = R6::R6Class("NeighborsForecaster",
                                                private$.params$indices <- fdays
                                                private$.params$window <- 1
                                        }
-                                       return ( data$getSerie(fdays[1])[1:horizon] ) #what else?!
+                                       return ( data$getSerie(fdays[1])[1:horizon] )
                                }
                        }
                        else