Chronometer {depCensoring} | R Documentation |
Chronometer object
Description
R6 object that mimics a chronometer. It can be started, paused, record legs and stopped.
Methods
Public methods
Method show()
Display the values stored in this chronometer object.
Usage
Chronometer$show()
Method reset()
Reset the chronometer.
Usage
Chronometer$reset()
Method start()
Start the chronometer
Usage
Chronometer$start()
Method stop()
Stop the chronometer
Usage
Chronometer$stop(leg.name = NULL)
Arguments
leg.name
(optional) Name for the stopped leg.
Method record.leg()
Record a leg time. The chronometer will continue running.
Usage
Chronometer$record.leg(leg.name = NULL)
Arguments
leg.name
Name for the recorded leg.
Method get.chronometer.data()
Like show
method, but more rudimentary.
Usage
Chronometer$get.chronometer.data()
Method get.total.time()
Return the total time span between start and stop.
Usage
Chronometer$get.total.time(force = FALSE)
Arguments
force
Boolean variable. If
TRUE
, avoids error when calling this function while chronometer has not been stopped yet.
Method accumulate.legs()
Return total time spent per leg category (using leg names).
Usage
Chronometer$accumulate.legs(force = FALSE)
Arguments
force
force Boolean variable. If
TRUE
, avoids error when calling this function while chronometer has not been stopped yet.
Method clone()
The objects of this class are cloneable with this method.
Usage
Chronometer$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.