timeline: Generic function for visualising the sessions on a time...

View source: R/trackeR.R

timelineR Documentation

Generic function for visualising the sessions on a time versus date plot

Description

Generic function for visualising the sessions on a time versus date plot

Timeline plot for trackeRdata objects.

Timeline plot for trackeRdataSummary objects

Usage

timeline(object, lims, ...)

## S3 method for class 'trackeRdata'
timeline(object, lims = NULL, ...)

## S3 method for class 'trackeRdataSummary'
timeline(object, lims = NULL, ...)

Arguments

object

An object of class trackeRdata or trackeRdataSummary.

lims

An optional vector of two times in HH:MM format. Default is NULL If supplied, the times are used to define the limits of the time axis.

...

Arguments passed to summary.trackeRdata.

Examples

## Not run: 
data('runs', package = 'trackeR')
## timeline plot applied on the \code{trackeRdata} object directly and with
## inferred limits for the time axis
timeline(runs)

## the same timeline plot applied on the \code{trackeRdataSummary} object
runSummary <- summary(runs)
timeline(runSummary, lims = c('00:01', '23:59'))

## End(Not run)

hfrick/trackeR documentation built on Feb. 3, 2024, 2:30 p.m.