class.signal: signalSeries Class

In splusTimeSeries: Time Series from 'S-PLUS'

signalSeries Class

Description

Represents non-calendar time series and signal objects.

Details

The signalSeries class inherits from the series and seriesVirtualclasses. It has slots that hold x positions and variable data inherited from the series class.

A signalSeries object is valid only when the lengths of the positions and data match, the data is a rectangular object, and the positions slot holds a positionsNumeric object.

Slots

All slots except the last, units.position, come from the series object.

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, which must be of type positionsNumeric.

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) the units for the data.

title

(character) the title of the data set.

documentation

(character) user-supplied documentation.

attributes

(ANY) the attributes slot for arbitrary use.

units.position

(character) the units for the positions slot.

signalSeries functions

You can create objects of class signalSeries using the new function, in which case they are set up to be empty. Alternatively, you can create objects of class signalSeries using the signalSeries function.

These objects can be subscripted and used in mathematical operations much like data frames or matrices.

See Also

series class, signalSeries, is.rectangular.

splusTimeSeries documentation built on Sept. 30, 2024, 9:18 a.m.