class.time.series: Calendar Time Series Class

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

Calendar Time Series Class

Description

Represents calendar time series objects.

Details

The timeSeries class inherits series and seriesVirtual. From series, it inherits slots that hold x positions and variable data. A timeSeries object is valid only when the lengths of the positions and data match, the data slot is rectangular, and the positions slot holds a positionsCalendar object.

Slots

All slots except the last two, fiscal.year.start and type, are inherited from the base series class.

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 positionsCalendar.

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.

fiscal.year.start

(numeric) the month number for fiscal year start.

type

(character) the type of time series.

Series functions

You can create objects of class timeSeries using the new function, in which case they are set up to be empty and have their fiscal year starting in January. Alternatively, you can create objects of class timeSeries using the timeSeries function.

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

See Also

series class, timeSeries, is.rectangular.

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