TrendSLR (version 1.0)

summary: Summary outputs of decomposed time series.

Description

Summary outputs of decomposed time series.

Usage

summary(object, wdir = " ", save_summary = "FALSE")

Arguments

object

of class “msl.trend” (see msl.trend) or “custom.trend” (see custom.trend).

wdir

character string, providing the name of the directory to send output files (e.g., “C:/myproject/”) when the save_summary argument is set to "TRUE". If this field is left blank the save_summary argument is switched off and a message will be sent to the console.

save_summary

logical, if “TRUE” the printed summary of the returned object is exported direct to the working directory and saved as "summary_information.txt". Default = “FALSE”.

Details

This routine provides a screen summary of the respective outputs from a msl.trend or custom.trend object. The summary produced is identical to str( ) for an object of class “msl.trend” (see msl.trend) or “custom.trend” (see custom.trend).

See Also

msl.trend, custom.trend, Balt, s, t.

Examples

# NOT RUN {
data(s) # msl.trend object
data(t) # custom.trend object
summary(s) # summary for object of class 'msl.trend'
summary(t) # summary for object of class 'custom.trend'

# }