timetools (version 1.1-2)

TimeInstantDataFrame-class: Class "TimeInstantDataFrame"

Description

Class to hold time data that ARE not 'punctual'.

Details

Formally, the class consists of a data.frame and, for each row, a POSIXct. This class is provided to deal with punctual time data. Many of such classes are defined in other packages. This one is defined mainly to provide a punctual class compatible with TimeIntervalDataFrame and SubtimeDataFrame.

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

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

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

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

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("TimeInstantDataFrame", ...)...argument must be replaced by named arguments coresponding to slots of a TimeInstantDataFrame (see below). See alsonew.
• TimeInstantDataFrame (when, timezone='UTC', data=NULL, ...)Arguments of the function correspond to object slots. SeeTimeInstantDataFramefor details.
• RegularTimeInstantDataFrame (from, to, by, timezone='UTC', data=NULL)Wrapper to construct TimeInstantDataFrame with specific properties (seeRegularTimeInstantDataFrame).
• as.TimeInstantDataFrame (from, ...)Converting object to TimeInstantDataFrame.

}

Slots

{ [object Object],[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],[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],[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 TimeInstantDataFrame to other classes

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