From 0759fd581338a337272cf2f8ed2b541cb2c34e37 Mon Sep 17 00:00:00 2001 From: Matt Dancho Date: Sat, 28 Oct 2023 18:52:07 -0400 Subject: [PATCH] update docs --- R/anomalize.R | 2 ++ man/anomalize.Rd | 3 +++ 2 files changed, 5 insertions(+) diff --git a/R/anomalize.R b/R/anomalize.R index a681bada..785e15d0 100644 --- a/R/anomalize.R +++ b/R/anomalize.R @@ -13,6 +13,8 @@ #' @param .trend Controls the trend component. #' For STL, trend controls the sensitivity of the LOESS smoother, which is used to remove the remainder. #' Refer to [tk_get_trend()]. +#' @param .method The outlier detection method. Default: "stl". Currently +#' "stl" is the only method. "twitter" is planned. #' @param .iqr_alpha Controls the width of the "normal" range. Lower values are more conservative #' while higher values are less prone to incorrectly classifying "normal" observations. #' @param .clean_alpha Controls the threshold for cleaning diff --git a/man/anomalize.Rd b/man/anomalize.Rd index 138c2fd5..9daca6fc 100644 --- a/man/anomalize.Rd +++ b/man/anomalize.Rd @@ -33,6 +33,9 @@ Refer to \code{\link[=tk_get_frequency]{tk_get_frequency()}}.} For STL, trend controls the sensitivity of the LOESS smoother, which is used to remove the remainder. Refer to \code{\link[=tk_get_trend]{tk_get_trend()}}.} +\item{.method}{The outlier detection method. Default: "stl". Currently +"stl" is the only method. "twitter" is planned.} + \item{.iqr_alpha}{Controls the width of the "normal" range. Lower values are more conservative while higher values are less prone to incorrectly classifying "normal" observations.}