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).
(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
) the x values for the variables.
(positions
) the starting x value.
(positions
) the ending x value.
(positions
) future x values used for predictions.
(character
) units for the data.
(character
) title of the data set.
(character
) user-supplied documentation.
(ANY
) attributes slot for arbitrary use.
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.
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.
'>timeSeries
class, '>signalSeries
class, is.rectangular
.