Plot time series decomposition components using ggplot

Produces a ggplot object of seasonally decomposed time series for objects of class stl (created with stats::stl(), class seas (created with seasonal::seas()), or class decomposed.ts (created with stats::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.

See also

seasonal::seas(), stats::stl(), stats::decompose(), stats::StructTS(), stats::plot.stl().

Author

Mitchell O'Hara-Wild

Examples

library(ggplot2)
co2 |>
  decompose() |>
  autoplot()

nottem |>
  stl(s.window = "periodic") |>
  autoplot()

if (FALSE) { # \dontrun{
library(seasonal)
seas(USAccDeaths) |> autoplot()
} # }