diff --git a/docs/404.html b/docs/404.html index 2a2546e..e0e69fd 100644 --- a/docs/404.html +++ b/docs/404.html @@ -38,7 +38,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/articles/anomalize_methods.html b/docs/articles/anomalize_methods.html index 8d3d364..3fc9014 100644 --- a/docs/articles/anomalize_methods.html +++ b/docs/articles/anomalize_methods.html @@ -39,7 +39,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -97,7 +97,7 @@

Anomalize Methods

Business Science

-

2023-02-08

+

2023-10-31

Source: vignettes/anomalize_methods.Rmd @@ -188,7 +188,13 @@

1.C. Comparison

Load two libraries to perform the comparison.

 library(tidyverse)
-library(anomalize)
+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

Collect data on the daily downloads of the lubridate package. This comes from the data set, tidyverse_cran_downloads that is part of diff --git a/docs/articles/anomalize_quick_start_guide.html b/docs/articles/anomalize_quick_start_guide.html index 2b0e2e5..73f4ba7 100644 --- a/docs/articles/anomalize_quick_start_guide.html +++ b/docs/articles/anomalize_quick_start_guide.html @@ -39,7 +39,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -97,7 +97,7 @@

Anomalize Quick Start Guide

Business Science

-

2023-02-08

+

2023-10-31

Source: vignettes/anomalize_quick_start_guide.Rmd @@ -132,7 +132,13 @@

5-Minutes To Anomalize
 library(tidyverse)
 library(tibbletime)
-library(anomalize)
+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:

-
+
 tidyverse_cran_downloads %>%
     filter(package == "lubridate") %>%
     ungroup() %>%
@@ -235,19 +255,8 @@ 

Interested in Learning Anomaly

Business Science offers two 1-hour courses on Anomaly Detection:

diff --git a/docs/news/index.html b/docs/news/index.html index 75169fa..304abe3 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0
@@ -72,6 +72,20 @@

Changelog

Source: NEWS.md +
+ +

Prepare for supercession by timetk. Note that anomalize R package will be maintained for backwards compatibility. Users may wish to add these 2 lines of code to existing codebases that use the legacy anomalize R package:

+
+
+library(anomalize)
+
+anomalize <- anomalize::anomalize
+plot_anomalies <- anomalize::plot_anomalies
+
+
+ +

Republish on CRAN.

+

Bug Fixes

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index f6cb60b..b6c31ab 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: 2.19.2 +pandoc: 3.1.1 pkgdown: 2.0.7 pkgdown_sha: ~ articles: anomalize_methods: anomalize_methods.html anomalize_quick_start_guide: anomalize_quick_start_guide.html forecasting_with_cleaned_anomalies: forecasting_with_cleaned_anomalies.html -last_built: 2023-02-08T13:58Z +last_built: 2023-10-31T20:36Z diff --git a/docs/reference/anomalize.html b/docs/reference/anomalize.html index 3e96fb4..5256237 100644 --- a/docs/reference/anomalize.html +++ b/docs/reference/anomalize.html @@ -25,7 +25,7 @@ anomalize - 0.2.3 + 0.3.0
@@ -179,16 +179,8 @@

See also

Examples

-

+    
if (FALSE) {
 library(dplyr)
-#> 
-#> Attaching package: ‘dplyr’
-#> The following objects are masked from ‘package:stats’:
-#> 
-#>     filter, lag
-#> The following objects are masked from ‘package:base’:
-#> 
-#>     intersect, setdiff, setequal, union
 
 # Needed to pass CRAN check / This is loaded by default
 set_time_scale_template(time_scale_template())
@@ -198,24 +190,7 @@ 

Examples

tidyverse_cran_downloads %>% time_decompose(count, method = "stl") %>% anomalize(remainder, method = "iqr") -#> # A time tibble: 6,375 × 9 -#> # Index: date -#> # Groups: package [15] -#> package date observed season trend remainder remainde…¹ remai…² anomaly -#> <chr> <date> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> -#> 1 broom 2017-01-01 1053 -1007. 1708. 352. -1725. 1704. No -#> 2 broom 2017-01-02 1481 340. 1731. -589. -1725. 1704. No -#> 3 broom 2017-01-03 1851 563. 1753. -465. -1725. 1704. No -#> 4 broom 2017-01-04 1947 526. 1775. -354. -1725. 1704. No -#> 5 broom 2017-01-05 1927 430. 1798. -301. -1725. 1704. No -#> 6 broom 2017-01-06 1948 136. 1820. -8.11 -1725. 1704. No -#> 7 broom 2017-01-07 1542 -988. 1842. 688. -1725. 1704. No -#> 8 broom 2017-01-08 1479 -1007. 1864. 622. -1725. 1704. No -#> 9 broom 2017-01-09 2057 340. 1887. -169. -1725. 1704. No -#> 10 broom 2017-01-10 2278 563. 1909. -194. -1725. 1704. No -#> # … with 6,365 more rows, and abbreviated variable names ¹​remainder_l1, -#> # ²​remainder_l2 - +}
diff --git a/docs/reference/anomalize_methods.html b/docs/reference/anomalize_methods.html index 415b13f..1ccffc4 100644 --- a/docs/reference/anomalize_methods.html +++ b/docs/reference/anomalize_methods.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0
diff --git a/docs/reference/anomalize_package.html b/docs/reference/anomalize_package.html index b685b43..6e32cfb 100644 --- a/docs/reference/anomalize_package.html +++ b/docs/reference/anomalize_package.html @@ -33,7 +33,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/reference/clean_anomalies.html b/docs/reference/clean_anomalies.html index 2eead16..7163ebe 100644 --- a/docs/reference/clean_anomalies.html +++ b/docs/reference/clean_anomalies.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -111,6 +111,7 @@

See also

Examples


+if (FALSE) {
 library(dplyr)
 
 # Needed to pass CRAN check / This is loaded by default
@@ -122,24 +123,7 @@ 

Examples

time_decompose(count, method = "stl") %>% anomalize(remainder, method = "iqr") %>% clean_anomalies() -#> # A time tibble: 6,375 × 10 -#> # Index: date -#> # Groups: package [15] -#> package date observed season trend remainder remainde…¹ remai…² anomaly -#> <chr> <date> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> -#> 1 broom 2017-01-01 1053 -1007. 1708. 352. -1725. 1704. No -#> 2 broom 2017-01-02 1481 340. 1731. -589. -1725. 1704. No -#> 3 broom 2017-01-03 1851 563. 1753. -465. -1725. 1704. No -#> 4 broom 2017-01-04 1947 526. 1775. -354. -1725. 1704. No -#> 5 broom 2017-01-05 1927 430. 1798. -301. -1725. 1704. No -#> 6 broom 2017-01-06 1948 136. 1820. -8.11 -1725. 1704. No -#> 7 broom 2017-01-07 1542 -988. 1842. 688. -1725. 1704. No -#> 8 broom 2017-01-08 1479 -1007. 1864. 622. -1725. 1704. No -#> 9 broom 2017-01-09 2057 340. 1887. -169. -1725. 1704. No -#> 10 broom 2017-01-10 2278 563. 1909. -194. -1725. 1704. No -#> # … with 6,365 more rows, 1 more variable: observed_cleaned <dbl>, and -#> # abbreviated variable names ¹​remainder_l1, ²​remainder_l2 - +}
diff --git a/docs/reference/decompose_methods.html b/docs/reference/decompose_methods.html index cc1a6d9..274d31b 100644 --- a/docs/reference/decompose_methods.html +++ b/docs/reference/decompose_methods.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -137,6 +137,14 @@

See also

Examples


 library(dplyr)
+#> 
+#> Attaching package: ‘dplyr’
+#> The following objects are masked from ‘package:stats’:
+#> 
+#>     filter, lag
+#> The following objects are masked from ‘package:base’:
+#> 
+#>     intersect, setdiff, setequal, union
 
 tidyverse_cran_downloads %>%
     ungroup() %>%
@@ -158,7 +166,7 @@ 

Examples

#> 8 2017-01-08 32 -19.8 27.6 24.2 #> 9 2017-01-09 70 12.4 27.6 30.0 #> 10 2017-01-10 33 11.3 27.6 -5.95 -#> # … with 415 more rows +#> # ℹ 415 more rows
diff --git a/docs/reference/figures/README-tidyverse_anoms_1-1.png b/docs/reference/figures/README-tidyverse_anoms_1-1.png index 766b160..8254902 100644 Binary files a/docs/reference/figures/README-tidyverse_anoms_1-1.png and b/docs/reference/figures/README-tidyverse_anoms_1-1.png differ diff --git a/docs/reference/figures/README-unnamed-chunk-3-1.png b/docs/reference/figures/README-unnamed-chunk-3-1.png index dd6975c..f19ba10 100644 Binary files a/docs/reference/figures/README-unnamed-chunk-3-1.png and b/docs/reference/figures/README-unnamed-chunk-3-1.png differ diff --git a/docs/reference/index.html b/docs/reference/index.html index c876e11..8900540 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -76,7 +76,7 @@

General

anomalize_package

+

anomalize_package anomalize-package

anomalize: Tidy anomaly detection

diff --git a/docs/reference/plot_anomalies.html b/docs/reference/plot_anomalies.html index 3a84f86..c87b24d 100644 --- a/docs/reference/plot_anomalies.html +++ b/docs/reference/plot_anomalies.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -159,6 +159,7 @@

See also

Examples


+if (FALSE) {
 library(dplyr)
 library(ggplot2)
 
@@ -172,9 +173,6 @@ 

Examples

anomalize(remainder, method = "iqr") %>% time_recompose() %>% plot_anomalies(time_recomposed = TRUE) -#> frequency = 7 days -#> trend = 91 days - #### MULTIPLE TIME SERIES #### @@ -183,7 +181,7 @@

Examples

anomalize(remainder, method = "iqr") %>% time_recompose() %>% plot_anomalies(time_recomposed = TRUE, ncol = 3) - +}
diff --git a/docs/reference/plot_anomaly_decomposition.html b/docs/reference/plot_anomaly_decomposition.html index dadff8e..29c3125 100644 --- a/docs/reference/plot_anomaly_decomposition.html +++ b/docs/reference/plot_anomaly_decomposition.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/reference/prep_tbl_time.html b/docs/reference/prep_tbl_time.html index 65e5ea2..2bf2e20 100644 --- a/docs/reference/prep_tbl_time.html +++ b/docs/reference/prep_tbl_time.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/reference/tidyverse_cran_downloads.html b/docs/reference/tidyverse_cran_downloads.html index 9405b68..994f64c 100644 --- a/docs/reference/tidyverse_cran_downloads.html +++ b/docs/reference/tidyverse_cran_downloads.html @@ -40,7 +40,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/reference/time_apply.html b/docs/reference/time_apply.html index e31dc55..fe12e46 100644 --- a/docs/reference/time_apply.html +++ b/docs/reference/time_apply.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -178,7 +178,7 @@

Examples

#> 8 broom 2017-01-08 1479 1716 #> 9 broom 2017-01-09 2057 1716 #> 10 broom 2017-01-10 2278 1716 -#> # … with 6,365 more rows +#> # ℹ 6,365 more rows
diff --git a/docs/reference/time_decompose.html b/docs/reference/time_decompose.html index 6cef0bf..a204fc8 100644 --- a/docs/reference/time_decompose.html +++ b/docs/reference/time_decompose.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -217,7 +217,7 @@

Examples

#> 8 broom 2017-01-08 1479 -1007. 1864. 622. #> 9 broom 2017-01-09 2057 340. 1887. -169. #> 10 broom 2017-01-10 2278 563. 1909. -194. -#> # … with 6,365 more rows +#> # ℹ 6,365 more rows # twitter tidyverse_cran_downloads %>% @@ -242,7 +242,7 @@

Examples

#> 8 broom 2017-01-08 1479 1479 -871. 2337 13.1 #> 9 broom 2017-01-09 2057 2057 304. 2337 -584. #> 10 broom 2017-01-10 2278 2278 503. 2337 -562. -#> # … with 6,365 more rows +#> # ℹ 6,365 more rows
diff --git a/docs/reference/time_frequency.html b/docs/reference/time_frequency.html index 9417df0..69c9ba2 100644 --- a/docs/reference/time_frequency.html +++ b/docs/reference/time_frequency.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 diff --git a/docs/reference/time_recompose.html b/docs/reference/time_recompose.html index 7aba865..a6c7811 100644 --- a/docs/reference/time_recompose.html +++ b/docs/reference/time_recompose.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0 @@ -127,21 +127,20 @@

Examples

#> # A time tibble: 6,375 × 11 #> # Index: date #> # Groups: package [15] -#> package date observed season trend remainder remainde…¹ remai…² anomaly -#> <chr> <date> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <chr> -#> 1 broom 2017-01-01 1053 -1007. 1708. 352. -1725. 1704. No -#> 2 broom 2017-01-02 1481 340. 1731. -589. -1725. 1704. No -#> 3 broom 2017-01-03 1851 563. 1753. -465. -1725. 1704. No -#> 4 broom 2017-01-04 1947 526. 1775. -354. -1725. 1704. No -#> 5 broom 2017-01-05 1927 430. 1798. -301. -1725. 1704. No -#> 6 broom 2017-01-06 1948 136. 1820. -8.11 -1725. 1704. No -#> 7 broom 2017-01-07 1542 -988. 1842. 688. -1725. 1704. No -#> 8 broom 2017-01-08 1479 -1007. 1864. 622. -1725. 1704. No -#> 9 broom 2017-01-09 2057 340. 1887. -169. -1725. 1704. No -#> 10 broom 2017-01-10 2278 563. 1909. -194. -1725. 1704. No -#> # … with 6,365 more rows, 2 more variables: recomposed_l1 <dbl>, -#> # recomposed_l2 <dbl>, and abbreviated variable names ¹​remainder_l1, -#> # ²​remainder_l2 +#> package date observed season trend remainder remainder_l1 remainder_l2 +#> <chr> <date> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 broom 2017-01-01 1053 -1007. 1708. 352. -1725. 1704. +#> 2 broom 2017-01-02 1481 340. 1731. -589. -1725. 1704. +#> 3 broom 2017-01-03 1851 563. 1753. -465. -1725. 1704. +#> 4 broom 2017-01-04 1947 526. 1775. -354. -1725. 1704. +#> 5 broom 2017-01-05 1927 430. 1798. -301. -1725. 1704. +#> 6 broom 2017-01-06 1948 136. 1820. -8.11 -1725. 1704. +#> 7 broom 2017-01-07 1542 -988. 1842. 688. -1725. 1704. +#> 8 broom 2017-01-08 1479 -1007. 1864. 622. -1725. 1704. +#> 9 broom 2017-01-09 2057 340. 1887. -169. -1725. 1704. +#> 10 broom 2017-01-10 2278 563. 1909. -194. -1725. 1704. +#> # ℹ 6,365 more rows +#> # ℹ 3 more variables: anomaly <chr>, recomposed_l1 <dbl>, recomposed_l2 <dbl> diff --git a/docs/reference/time_scale_template.html b/docs/reference/time_scale_template.html index 5058eaf..613e28e 100644 --- a/docs/reference/time_scale_template.html +++ b/docs/reference/time_scale_template.html @@ -23,7 +23,7 @@ anomalize - 0.2.3 + 0.3.0