timetools (version 1.5.2)

split: Divide into Groups and Reassemble (Time*DataFrame objects and POSIXct*)

Description

split divides the data in the vector x into the groups defined by f. The replacement forms replace values corresponding to such a division. Here are listed split methods defined for Time objects defined in the timetools package (TimeIntervalDataFrame, TimeInstantDataFrame, POSIXst, POSIXcti, etc.). See sections below for complete list of methods.

Usage

## S3 method for class 'POSIXctp':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'POSIXcti':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'POSIXst':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'TimeInstantDataFrame':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'TimeIntervalDataFrame':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'SubtimeDataFrame':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'ANY,POSIXctp':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'ANY,POSIXcti':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'ANY,POSIXst':
split(x, f, drop = FALSE, ...)
  ## S3 method for class 'TimeIntervalDataFrame,TimeIntervalDataFrame':
split(x, f, ..., split.x=FALSE, keep.f=TRUE)
  ## S3 method for class 'TimeIntervalDataFrame,POSIXcti':
split(x, f, ..., split.x=FALSE)
  ## S3 method for class 'TimeIntervalDataFrame,POSIXctp':
split(x, f, ...,  split.x=FALSE)

Arguments

x

vector or data frame containing values to be divided into groups. POSIXctp, POSIXst and POSIXcti are considered as vectors and TimeIntervalDataFrame, TimeInstantDataFrame and SubtimeDataFrame as data.frame.

f

Can be of different kind. Is used to defined the grouping. See details below.

drop

logical indicating if levels that do not occur should be dropped (if f is a factor or a list).

...

further potential arguments passed to methods.

split.x

logical indicating if data in x that are over several intervals or not completely included in one interval of f must be 'cut' to fit to new intervals (TRUE) or ignored (FALSE).

keep.f

logical indicating if f values must be kept on the resulting list.

Value

• The value returned from ‘split’ is a list of vectors containing the values for the groups. The components of the list are named by the levels of f (after converting to a factor). The class of each element of the list is the one of the initial x structure.

Split POSIX*t* objects

The following (S3) methods are wrappers to the split.default method defined in the package 'base'. Those methods allow to split POSIXctp, POSIXst POSXcti objects which are similar to vectors. See split for details about f and drop.

• split('POSIXctp', f, drop = FALSE, ...)

split('POSIXcti', f, drop = FALSE, ...) split('POSIXst', f, drop = FALSE, ...)

Split Time*DataFrame

The following (S3) methods are wrappers to the split.data.frame method defined in the package 'base'. Those methods allow to split SubtimeDataFrame, TimeInstantDataFrame and TimeIntervalDataFrame in the same way that data.frame are used to be splitted.

• split('TimeInstantDataFrame', f, drop = FALSE, ...)

split('TimeIntervalDataFrame', f, drop = FALSE, ...) split('SubtimeDataFrame', f, drop = FALSE, ...)

split('TimeIntervalDataFrame', 'TimeIntervalDataFrame', ..., split.x = FALSE, keep.f = TRUE)

Split a TimeIntervalDataFrame into another TimeIntervalDataFrame.

The method takes each time interval of the first TimeIntervalDataFrame (TitDF) and searches with which time intervals of the second it intersects.

Each time interval of the first TItDF can intersect with none, one or several time intervals of the second TItDF. The arguments 'split.x' is defined to tell the method what to do :

• if the time interval in the first TItDF (ti1) doesn't match any in the second TItDF, nothing to do

if it (ti1) matches one in the second TItDF (ti2) and is included inside it, it (ti1) is entirely taken in the final result if it (ti1) intersects one and only one (ti2) inside the second TItDF, (ti1) is truncated to be included inside (ti2) if 'split.x' is TRUE and (ti1) is removed if 'split.x' is FALSE if it (ti1) is over several time intervals of the second TItDF (ti2.a, ti2.b, etc.) :

• if 'split.x' is TRUE, (ti1) is truncated into each ti2.x to be included inside each one

if 'split.x' is FALSE, (ti1) is removed.

split('TimeIntervalDataFrame', 'POSIXctp', ..., split.x = FALSE)

Split a TimeIntervalDataFrame into a time period (of length 1). A TimeIntervalDataFrame is created (cf TimeIntervalDataFrame constructor) and the the above method is called.

split('TimeIntervalDataFrame', 'POSIXcti', ..., split.x = FALSE)

Split a TimeIntervalDataFrame into time intervals (POSIXcti). It is exactly the same as splitting a TimeIntervalDataFrame into another except that 'f' has not data.

So a TimeIntervalDataFrame is created according to 'f' and the the above method is called.

Details

For each new split method defined in timetools a short description is given there.

See Also

split, TimeIntervalDataFrame-class, TimeInstantDataFrame-class, SubtimeDataFrame-class, POSIXcti-class, POSIXst-class, POSIXctp-class