timeSingle: timeSingle

In jaredlander/useful: A Collection of Handy, Useful Functions

timeSingle

Description

Convenience function that takes in a time object and calculates a difference with a user specified prompt

Usage

timeSingle(
  string = "Time difference",
  startTime,
  endTime = Sys.time(),
  sep = ":"
)

Arguments

string	string of what was timed
startTime	"POSIXct" "POSIXt" object, usually from Sys.time
endTime	"POSIXct" "POSIXt" object, usually from Sys.time
sep	string, usually character that is used as the separator between user prompt and time difference

Value

prompt_string string user prompt with time difference

Author(s)

Daniel Y. Chen

Examples

x <- 3.14
strt <- Sys.time()
sq <- x ** 2
timeSingle('Squaring value', strt)

jaredlander/useful documentation built on Nov. 4, 2023, 10:56 a.m.