forecast (version 9.0.0)

autoplot.decomposed.ts: Plot time series decomposition components using ggplot

Description

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 decomposed.ts
autoplot(object, labels = NULL, range.bars = NULL, ...)
# S3 method for stl
autoplot(object, labels = NULL, range.bars = TRUE, ...)
# S3 method for StructTS
autoplot(object, labels = NULL, range.bars = TRUE, ...)
# S3 method for seas
autoplot(object, labels = NULL, range.bars = NULL, ...)
# S3 method for mstl
autoplot(object, ...)

Value

Returns an object of class ggplot.

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.

Author

Mitchell O'Hara-Wild

See Also

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

Examples

library(ggplot2)
co2 |>
  decompose() |>
  autoplot()
nottem |>
  stl(s.window = "periodic") |>
  autoplot()
if (FALSE) {
library(seasonal)
seas(USAccDeaths) |> autoplot()
}