seasonal (version 0.40.0)

out: Diagnostical Re-Evaluation

Description

For diagnostical purposes, these functions re-evaluate an object of class seas and capture the full content or parts of the .out file from X-13ARIMA-SEATS.

Usage

out(x, line = 1, n = 100, search = NULL, ...)
revisions(x, ...)
slidingspans(x, ...)

Arguments

x

an object of class "seas" to re-evaluate.

line

starting line of the content.

n

number of lines to show at once.

search

chracter string. If specified, the content is searched for the first occurence of the string (see examples).

...

aditional spec-arguments options (see details).

Value

• invisible, the full content or parts of the .out file as a (large) character vector. The content of the vector is displayed by a viewer function in the R console.

Details

The out function shows the full content of the .out file form X-13ARIMA-SEATS. The slidingspans and revisions function call the 'slidingspans' and 'history' spec of X-13ARIMA-SEATS and show the respective parts of the .out file. Note that against the convention, the 'history' spec is called by the function revision, in order to avoid a naming collision with the function from the preloaded utils package. For a description of the 'slidingsspan' and 'history' spec, consider the X-13ARIMA-SEATS manual.

For how to enter spec-arguments options, see the details in "seas". In the out function, ... are useful to add additional outputs to the .out file. In the slidingspans and revisions function, ... are used to add additional options to the 'slidingspans' and 'history' spec.

References

Vignette with a more detailed description: http://cran.r-project.org/web/packages/seasonal/vignettes/seas.pdf

Wiki page with a comprehensive list of R examples from the X-13ARIMA-SEATS manual: https://github.com/christophsax/seasonal/wiki/Examples-of-X-13ARIMA-SEATS-in-R

Official X-13ARIMA-SEATS manual: http://www.census.gov/ts/x13as/docX13AS.pdf

See Also

seas for the main function of seasonal.

plot.seas, for plot methods for slidingspans and revisions.

Examples

m <- seas(AirPassengers)

# exit from the viewer with [q]
out(m)
out(m, search = "regARIMA model residuals")

slidingspans(m)
revisions(m)

# plot method for slingspans and revisions (see ?plot.seas)
plot(slidingspans(m))
plot(revisions(m))