Summary Method for a Regular Time Series

DESCRIPTION:

Returns a list of summary information about a regularly spaced time series.

USAGE:

summary.rts(object) 

REQUIRED ARGUMENTS:

object
time series object of class "rts", that is, one representing a time series that was sampled at constant time intervals.

VALUE:

list containing the class of the series, the dimensions, a summary of its data, and the time parameters.

DETAILS:

This is the method for objects of class "rts" of the generic function summary .

WARNING:

If you call summary.rts directly for a non- rts object, it will assume you have a Regular Time Series, and may have incorrect information about the time parameters.

SEE ALSO:

, .

EXAMPLES:

lynx.rts <- as.rts(lynx) 
summary(lynx.rts) 
# Produces:
# Regular Time Series: 
# Observations: 114 
#  Min. 1st Qu. Median Mean 3rd Qu. Max. 
#    39   348.2    771 1538    2567 6991 
# Time Parameters : 
#  start deltat frequency 
#  1821     1      1