timetools (version 1.1-2)

SubtimeDataFrame-class: Class "SubtimeDataFrame"

Description

Class to hold subtime data such a day of week, month of year, etc.

Details

Formally, the class consists of a data.frame and, for each row, a subtime. This class is provided to deal with subtime data. This class is compatible with TimeIntervalDataFrame and TimeInstantDataFrame.

To list all methods available for SubtimeDataFrame, type in the R console :

methods(class='SubtimeDataFrame') # for S3 methods}

showMethods(class='SubtimeDataFrame') # for S4 methods}

To get back to this documentation from the R console : class?SubtimeDataFrame

The construction of the class allows to manipulate objects as if they were data.frame (see Access to data and Access to data properties). Several functions are also available to access to time properties (see Access to time properties). Methods are also available to facilitate the representations of instances of that class : see graphic representation and text representation.

Finally, some specific methods allow to easily deal with agregation of data over time properties (day, hour, week, special or specific time).

Objects from the Class

{ Objects can be created by calls of the form

• new("SubtimeDataFrame", ...)...argument must be replaced by named arguments coresponding to slots of a SubtimeDataFrame (see below). See alsonew.
• SubtimeDataFrame (when, data=NULL, ...)Arguments of the function correspond to object slots. SeeSubtimeDataFramefor details.
• as.SubtimeDataFrame (from, representation, cursor=NULL, FUN=mean, ...)Converting object to SubtimeDataFrame.

}

Slots

{ [object Object],[object Object] }

Access to and manipulate data

{ [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] }

Access to data properties

{ [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object] }

Access to time properties

{ [object Object],[object Object] }

Graphic representation

{ [object Object],[object Object],[object Object] }

Text representation

{ [object Object],[object Object],[object Object],[object Object],[object Object] }

Specific methods

{ Actually, there is no specific methods for this class. }

Converting SubtimeDataFrame to other classes

{ [object Object] } TimeInstantDataFrame, TimeIntervalDataFrame, subtime showClass("SubtimeDataFrame") classes