class.ordered.data: Base Class for Time Series and Signals

In spkaluzny/splusTimeSeries: Time Series from 'S-PLUS'

Base Class for Time Series and Signals

Description

A base class representing ordered data objects, such as time series and signals, that have positions (x values, times), and for each position a set of variables (stored in any rectangular data object).

Details

The series class holds x positions and variable data. It is valid only when the lengths of the positions and data match, and when the data slot is a rectangular object.

seriesVirtual is a virtual class corresponding to series. All of the methods for series objects are defined on the corresponding virtual seriesVirtual class so they can be inherited easily by extending classes.

series has two built-in extending classes: timeSeries and signalSeries. series is not meant to be used directly. Instead, most users should use the signalSeries and timeSeries classes. Extending classes should include both series and seriesVirtual in their representations.

Slots

data

(ANY) the variable data, which can be any data object for which is.rectangular is TRUE, such as a data.frame, matrix, or atomic vector.

positions

(positions) the x values for the variables.

start.position

(positions) the starting x value.

end.position

(positions) the ending x value.

future.positions

(positions) future x values used for predictions.

units

(character) units for the data.

title

(character) title of the data set.

documentation

(character) user-supplied documentation.

attributes

(ANY) attributes slot for arbitrary use.

Series functions

• The series class has a validity function, seriesValid.

• The access functions positions and seriesData can access the positions and data in the object, and they can be used on the left side of assignments.

• There are also methods defined for series objects for the following functions:

  • nrow

  • ncol

  • start

  • end

  • subscripting

  • the standard rectangular data functions (see is.rectangular)

  • basic arithmetic.

See Also

timeSeries class, signalSeries class, is.rectangular.

spkaluzny/splusTimeSeries documentation built on Sept. 20, 2024, 3:39 a.m.