dtt_timer: Use a dtt_timer

In poissonconsulting/dttr: Manipulate Date and Time Objects

Description

Use a dtt_timer

Usage

dtt_timer(seconds = 0L, start = FALSE)

dtt_start(x)

dtt_stop(x)

dtt_elapsed(x)

dtt_reset(x, seconds = 0L, start = FALSE)

dtt_is_running(x)

Arguments

seconds	A count of the start time in seconds.
start	A flag indicating whether to start the timer.
x	A dtt_timer object.

Value

A dtt_timer

Functions

• dtt_start: Start

• dtt_stop: Stop

• dtt_elapsed: Elapsed Duration

• dtt_reset: Reset

• dtt_is_running: Is Running

Examples

# create a new timer
t <- dtt_timer()

# no time has elapsed because the timer has not started
dtt_elapsed(t)

# start the timer
t <- dtt_start(t)

# get the time elapsed
# time elapsed is increasing because the timer is still running
dtt_elapsed(t)
dtt_elapsed(t)

# stop the timer
t <- dtt_stop(t)

# time elapsed is now fixed
dtt_elapsed(t)
dtt_elapsed(t)

# reset the timer
t <- dtt_reset(t)
dtt_elapsed(t)

poissonconsulting/dttr documentation built on Feb. 20, 2021, 12:18 a.m.