prep for supercession by timetk

README.Rmd

@@ -19,6 +19,22 @@ devtools::load_all()
 library(tidyverse)
 ```
 
+# Anomalize is being Superceded by Timetk:
+
+The `anomalize` package functionality has been superceded by `timetk`. We suggest you begin to use the `timetk::anomalize()` to benefit from enhanced functionality to get improvements going forward. [Learn more about Anomaly Detection with `timetk` here.](https://business-science.github.io/timetk/articles/TK08_Automatic_Anomaly_Detection.html) 
+
+The original `anomalize` package functionality will be maintained for previous code bases that use the legacy functionality. 
+
+To prevent the new `timetk` functionality from conflicting with old `anomalize` code, use these lines:
+
+``` r
+library(anomalize)
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
+```
+
+
 <!-- # anomalize -->
 # anomalize <img src="man/figures/anomalize-logo.png" width="147" height="170" align="right" />
 
@@ -63,6 +79,13 @@ Load the `tidyverse` and `anomalize` packages.
 ```{r, eval = F}
 library(tidyverse)
 library(anomalize)
+
+# NOTE: timetk now has anomaly detection built in, which 
+#  will get the new functionality going forward.
+#  Use this script to prevent overwriting legacy anomalize:
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
 ```
 
 

README.md

@@ -1,5 +1,27 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# Anomalize is being Superceded by Timetk:
+
+The `anomalize` package functionality has been superceded by `timetk`.
+We suggest you begin to use the `timetk::anomalize()` to benefit from
+enhanced functionality to get improvements going forward. [Learn more
+about Anomaly Detection with `timetk`
+here.](https://business-science.github.io/timetk/articles/TK08_Automatic_Anomaly_Detection.html)
+
+The original `anomalize` package functionality will be maintained for
+previous code bases that use the legacy functionality.
+
+To prevent the new `timetk` functionality from conflicting with old
+`anomalize` code, use these lines:
+
+``` r
+library(anomalize)
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
+```
+
 <!-- # anomalize -->
 
 # anomalize <img src="man/figures/anomalize-logo.png" width="147" height="170" align="right" />
@@ -55,6 +77,13 @@ Load the `tidyverse` and `anomalize` packages.
 ``` r
 library(tidyverse)
 library(anomalize)
+
+# NOTE: timetk now has anomaly detection built in, which 
+#  will get the new functionality going forward.
+#  Use this script to prevent overwriting legacy anomalize:
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
 ```
 
 Next, let’s get some data. `anomalize` ships with a data set called

vignettes/anomalize_methods.Rmd

@@ -63,6 +63,12 @@ Load two libraries to perform the comparison.
 ```{r, eval = F}
 library(tidyverse)
 library(anomalize)
+
+# NOTE: timetk now has anomaly detection built in, which 
+#  will get the new functionality going forward.
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
 ```
 
 

vignettes/anomalize_quick_start_guide.Rmd

@@ -41,6 +41,12 @@ Load libraries.
 library(tidyverse)
 library(tibbletime)
 library(anomalize)
+
+# NOTE: timetk now has anomaly detection built in, which 
+#  will get the new functionality going forward.
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
 ```
 
 Get some data. We'll use the `tidyverse_cran_downloads` data set that comes with `anomalize`. A few points:

vignettes/forecasting_with_cleaned_anomalies.Rmd

@@ -33,6 +33,13 @@ library(tidyverse)
 library(tidyquant)
 library(anomalize)
 library(timetk)
+
+# NOTE: timetk now has anomaly detection built in, which 
+#  will get the new functionality going forward.
+#  Use this script to prevent overwriting legacy anomalize:
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
 ```
 
 Here is a short example with the `tidyverse_cran_downloads` dataset that comes with `anomalize`. __We'll see how we can reduce the forecast error by 32% simply by repairing anomalies.__