Learn R Programming

timetools (version 1.1-2)

TimeIntervalDataFrame-class: Class "TimeIntervalDataFrame"

Description

Class to hold time data that are NOT 'punctual'.

Arguments

Details

Formally, the class consists of a data.frame and, for each row, two POSIXct that can be summarize as time interval with the POSIXcti class. This allows to manipulate at once time data without any restriction on time representation : data can occur at different time, data can be discontinuous, data can be unhomogeneous (not lasting for a unique period), data can overlay each other, etc. There are several methods to test/deal/ensure that these properties are respected or not, see below.

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

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

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

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

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 intervals).

Objects from the Class
{ Objects can be created by calls of the form
  • new("TimeIntervalDataFrame", ...)...argument must be replaced by named arguments coresponding to slots of a TimeIntervalDataFrame (see below). See alsonew.
  • TimeIntervalDataFrame (start, end=NULL, timezone='UTC', data=NULL, ...)Arguments of the function correspond to object slots. SeeTimeIntervalDataFramefor details.
  • RegularTimeIntervalDataFrame (from, to, by, period, timezone='UTC', data=NULL)Wrapper to construct TimeIntervalDataFrame with specific properties (seeRegularTimeIntervalDataFrame).
  • as.TimeIntervalDataFrame (from, ...)Converting object to TimeIntervalDataFrame.
}
Slots
{ [object Object],[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],[object Object],[object Object],[object Object],[object Object],[object Object],[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
{ [object Object],[object Object],[object Object] }
Converting TimeIntervalDataFrame to other classes
{ [object Object],[object Object],[object Object] } TimeInstantDataFrame, SubtimeDataFrame, POSIXcti, POSIXctp showClass("TimeIntervalDataFrame") classes