Helper function for displaying time taken messages within other functions.
Use proc.time at start of function and supply this as the
start_time parameter to this function.
time_taken_message(start_time)
Arguments
- start_time
The start time.
Value
A message stating time taken since start time
Examples
# a function that sleeps for a specified duration and displays a
# 'time taken' message when completed
sleep_fn <- function(duration) {
start_time <- proc.time()
Sys.sleep(duration)
time_taken_message(start_time)
}
sleep_fn(1)
#> Time taken: 0 minutes, 1 seconds.