Describe differences with forecast for guerrero()

Resolves #114
tidyverts · Aug 10, 2020 · 830fe40 · 830fe40
1 parent f89e919
commit 830fe40
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/R/guerrero.R b/R/guerrero.R
@@ -16,6 +16,11 @@ lambda_coef_var <- function(lambda, x, .period = 2) {
 #' Applies Guerrero's (1993) method to select the lambda which minimises the
 #' coefficient of variation for subseries of x.
 #'
+#' Note that this function will give slightly different results to
+#' `forecast::BoxCox.lambda(y)` if your data does not start at the start of the
+#' seasonal period. This function will make use of all of your data, whereas the
+#' forecast package will not use data that doesn't complete a seasonal period.
+#'
 #' @param x A numeric vector. The data used to identify the transformation
 #' parameter lambda.
 #' @param lower The lower bound for lambda.

diff --git a/man/guerrero.Rd b/man/guerrero.Rd