Skip to content

Commit

Permalink
Rename logo + add favicons + build readme
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy committed Dec 6, 2023
1 parent b090b0a commit e10a362
Show file tree
Hide file tree
Showing 18 changed files with 22 additions and 11 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@
^CRAN-RELEASE$
^CRAN-SUBMISSION$
^\.github$
^pkgdown$
7 changes: 3 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ knitr::opts_chunk$set(
warning = F
)
library(anomalize)
library(dplyr) # for pipe
```


Expand Down Expand Up @@ -79,12 +80,11 @@ install.packages("anomalize")

## Getting Started

Load the `tidyverse` and `anomalize` packages.
Load the `anomalize` package. Usually, you will also load the tidyverse as well!

```{r, eval = F}
library(tidyverse)
library(anomalize)
library(tidyverse)
# NOTE: timetk now has anomaly detection built in, which
# will get the new functionality going forward.
# Use this script to prevent overwriting legacy anomalize:
Expand All @@ -99,7 +99,6 @@ Next, let's get some data. `anomalize` ships with a data set called `tidyverse_
Suppose we want to determine which daily download "counts" are anomalous. It's as easy as using the three main functions (`time_decompose()`, `anomalize()`, and `time_recompose()`) along with a visualization function, `plot_anomalies()`.

```{r tidyverse_anoms_1, fig.height=8}
library(magrittr)
tidyverse_cran_downloads %>%
# Data Manipulation / Anomaly Detection
time_decompose(count, method = "stl") %>%
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ install.packages("anomalize")

## Getting Started

Load the `tidyverse` and `anomalize` packages.
Load the `anomalize` package. Usually, you will also load the tidyverse
as well!

``` r
library(tidyverse)
library(anomalize)

library(tidyverse)
# NOTE: timetk now has anomaly detection built in, which
# will get the new functionality going forward.
# Use this script to prevent overwriting legacy anomalize:
Expand All @@ -102,7 +102,6 @@ anomalous. It’s as easy as using the three main functions
visualization function, `plot_anomalies()`.

``` r
library(magrittr)
tidyverse_cran_downloads %>%
# Data Manipulation / Anomaly Detection
time_decompose(count, method = "stl") %>%
Expand Down
Binary file modified man/figures/README-tidyverse_anoms_1-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-unnamed-chunk-3-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon.ico
Binary file not shown.
8 changes: 7 additions & 1 deletion vignettes/anomalize_methods.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ library(anomalize)
# load necessary tidyverse packages for analysis
library(dplyr)
library(ggplot2)
# NOTE: timetk now has anomaly detection built in, which
# will get the new functionality going forward.
anomalize <- anomalize::anomalize
plot_anomalies <- anomalize::plot_anomalies
```

Anomaly detection is critical to many disciplines, but possibly none more important than in __time series analysis__. A time series is the sequential set of values tracked over a time duration. The definition we use for an __anomaly__ is simple: an anomaly is something that happens that (1) was unexpected or (2) was caused by an abnormal event. Therefore, the problem we intend to solve with `anomalize` is providing methods to accurately detect these "anomalous" events.
Expand Down Expand Up @@ -62,7 +68,7 @@ The Twitter method is a similar decomposition method to that used in Twitter's `

Load two libraries to perform the comparison.

```{r, eval = F}
```r
library(tidyverse)
library(anomalize)

Expand Down
8 changes: 7 additions & 1 deletion vignettes/anomalize_quick_start_guide.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ knitr::opts_chunk$set(
library(tibbletime)
library(dplyr)
library(ggplot2)
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
```

The `anomalize` package is a feature rich package for performing anomaly detection. It's geared towards time series analysis, which is one of the biggest needs for understanding when anomalies occur. We have a quick start section called "5-Minutes to Anomalize" for those looking to jump right in. We also have a detailed section on parameter adjustment for those looking to understand what nobs they can turn. Finally, for those really looking to get under the hood, we have another vignette called "Anomalize Methods" that gets into a deep discussion on STL, Twitter, IQR and GESD methods that are used to power `anomalize`.
Expand All @@ -41,7 +47,7 @@ Check out our entire [Software Intro Series](https://www.youtube.com/watch?v=Gk_

Load libraries.

```{r, eval = T, message = F, warning = F}
```r
library(tidyverse)
library(tibbletime)
library(anomalize)
Expand Down
2 changes: 1 addition & 1 deletion vignettes/forecasting_with_cleaned_anomalies.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ library(timetk)

We can often get better forecast performance by cleaning anomalous data prior to forecasting. This is the perfect use case for integrating the `clean_anomalies()` function into your ___forecast workflow___.

```{r setup, message=FALSE, eval=FALSE}
```r
library(tidyverse)
library(tidyquant)
library(anomalize)
Expand Down

0 comments on commit e10a362

Please sign in to comment.