-
Notifications
You must be signed in to change notification settings - Fork 65
/
README.Rmd
76 lines (59 loc) · 3.07 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# fable <a href='https://fable.tidyverts.org'><img src='man/figures/logo.png' align="right" height="138.5" /></a>
<!-- badges: start -->
[](https://github.com/tidyverts/fable/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/github/tidyverts/fable?branch=master)
[](https://CRAN.R-project.org/package=fable)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
The R package *fable* provides a collection of commonly used univariate and multivariate time series forecasting models including exponential smoothing via state space models and automatic ARIMA modelling. These models work within the fable framework, which provides the tools to evaluate, visualise, and combine models in a workflow consistent with the tidyverse.
## Installation
You can install the **stable** version from [CRAN](https://cran.r-project.org/package=fable):
```{r cran-installation, eval = FALSE}
install.packages("fable")
```
You can install the **development** version from
[GitHub](https://github.com/tidyverts/fable)
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("tidyverts/fable")
```
Installing this software requires a compiler
## Example
```{r example, message=FALSE}
library(fable)
library(tsibble)
library(tsibbledata)
library(lubridate)
library(dplyr)
aus_retail %>%
filter(
State %in% c("New South Wales", "Victoria"),
Industry == "Department stores"
) %>%
model(
ets = ETS(box_cox(Turnover, 0.3)),
arima = ARIMA(log(Turnover)),
snaive = SNAIVE(Turnover)
) %>%
forecast(h = "2 years") %>%
autoplot(filter(aus_retail, year(Month) > 2010), level = NULL)
```
## Learning to forecast with fable
- The pkgdown site describes all models provided by fable, and how they are used: https://fable.tidyverts.org/
- The forecasting principles and practices online textbook provides an introduction to time series forecasting using fable: https://otexts.com/fpp3/ (WIP)
<!-- - A quick start functionality guide can be found here: https://tidyverts.github.io/tidy-forecasting-principles/ (WIP) -->
## Getting help
- Questions about forecasting can be asked on [Cross Validated](https://stats.stackexchange.com/tags/forecasting).
- Common questions about the fable package are often found on [Stack Overflow](https://stackoverflow.com/tags/fable+r). You can use this to ask for help if the question isn't already answered. A [minimally reproducible example](https://www.tidyverse.org/help/) that describes your issue is the best way to ask for help!