forecast: autoplot.seas – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

autoplot.seas

Plot time series decomposition components using ggplot

Description

Produces a ggplot object of seasonally decomposed time series for objects of class “stl” (created with stl), class “seas” (created with seas), or class “decomposed.ts” (created with decompose).

Usage

## S3 method for class 'decomposed.ts'
autoplot(object, labels = NULL, range.bars = NULL, ...)

## S3 method for class 'stl'
autoplot(object, labels = NULL, range.bars = TRUE, ...)

## S3 method for class 'StructTS'
autoplot(object, labels = NULL, range.bars = TRUE, ...)

## S3 method for class 'seas'
autoplot(object, labels = NULL, range.bars = NULL, ...)

## S3 method for class 'mstl'
autoplot(object, ...)

Arguments

`object`	Object of class “`seas`”, “`stl`”, or “`decomposed.ts`”.
`labels`	Labels to replace “seasonal”, “trend”, and “remainder”.
`range.bars`	Logical indicating if each plot should have a bar at its right side representing relative size. If `NULL`, automatic selection takes place.
`...`	Other plotting parameters to affect the plot.

Value

Returns an object of class ggplot.

Author(s)

Mitchell O'Hara-Wild

Examples

library(ggplot2)
co2 %>%
  decompose() %>%
  autoplot()
nottem %>%
  stl(s.window = "periodic") %>%
  autoplot()
## Not run: 
library(seasonal)
seas(USAccDeaths) %>% autoplot()

## End(Not run)

forecast

Forecasting Functions for Time Series and Linear Models

v8.14

GPL-3

Authors

Rob Hyndman [aut, cre, cph] (<https://orcid.org/0000-0002-2140-5352>), George Athanasopoulos [aut], Christoph Bergmeir [aut] (<https://orcid.org/0000-0002-3665-9021>), Gabriel Caceres [aut], Leanne Chhay [aut], Mitchell O'Hara-Wild [aut] (<https://orcid.org/0000-0001-6729-7695>), Fotios Petropoulos [aut] (<https://orcid.org/0000-0003-3039-4955>), Slava Razbash [aut], Earo Wang [aut], Farah Yasmeen [aut] (<https://orcid.org/0000-0002-1479-5401>), R Core Team [ctb, cph], Ross Ihaka [ctb, cph], Daniel Reid [ctb], David Shaub [ctb], Yuan Tang [ctb] (<https://orcid.org/0000-0001-5243-233X>), Zhenyu Zhou [ctb]

Initial release