sweep (version 0.2.5)

sw_tidy: Tidy the result of a time-series model into a summary tibble

Description

Tidy the result of a time-series model into a summary tibble

Usage

sw_tidy(x, ...)

Value

a tibble

Arguments

x

An object to be converted into a tibble ("tidy" data.frame)

...

extra arguments

Details

sw_tidy() is a wrapper for broom::tidy(). The main benefit of sw_tidy() is that it has methods for various time-series model classes such as HoltWinters, ets, Arima, etc. sw_tidy() methods always returns a "tidy" tibble with model coefficient / parameters.

For non-time series, sw_tidy() defaults to broom::tidy(). The only difference is that the return is a tibble. The output of sw_tidy() is always a tibble with disposable row names. It is therefore suited for further manipulation by packages like dplyr and ggplot2.

See Also

broom::tidy()

Examples

library(dplyr)
library(forecast)
library(sweep)

WWWusage %>%
    auto.arima() %>%
    sw_tidy(conf.int = TRUE)