Skip to contents

Summary for dfts Object

summary.dfts.Rd

General summary function to view data overview. Several plots and test statistics are returned to give a general view of the data. More details can be found with more specialized functions.

Usage

# S3 method for class 'dfts'
summary(object, changes = NULL, lag.max = 20, d.max = 2, demean = FALSE, ...)

Arguments

object

A dfts object or data which can be automatically converted to that format. See dfts().

changes

Vector of change locations, if there are any. Default is NULL.

lag.max

Max lags to consider for ACF. Default is 20.

d.max

Max number of dimensions for QQ-plot.

demean

Boolean if data should be demeaned based on changes and create plots based on these residuals.

...

Data to pass into underlying functions like the KPSS, portmanteau, and stationary tests. In general it is recommended to not use this and instead apply the specialized functions directly.

Value

List with the elements:

  1. summary_data: summary results for the data.

  2. summary_plot: summary plot for the data.

See also

base::summary()

Examples

res <- summary(electricity[,1:20], lag.max=2)
#> Warning: no DISPLAY variable so Tk is not available