tic: Stopwatch to measure timings in R

In lares: Analytics & Machine Learning Sidekick

Stopwatch to measure timings in R

Description

Start a stopwatch.

Stop a stopwatch.

Usage

tic(id = 1, start = proc.time()["elapsed"], quiet = TRUE)

toc(
  id = 1,
  msg = "Elapsed time:",
  type = "units",
  signif = 3,
  quiet = FALSE,
  ...
)

Arguments

id	Define ID if multiple tic & toc are being used.
start	Start time. Now is default.
quiet	Boolean. Quiet messages?
msg	Character. Custom message shown
type	Character. Output format for time list element. Choose any of: units, clock, seconds.
signif	Integer. Significant digits.
...	Additional parameters.

Value

Invisible list. Contains tic (start time), toc (stop time), elapsed time and message printed.

toc returns an (invisible) list containing the time-stamps tic and toc, time in seconds and the message msg.

See Also

Other Tools: autoline(), bind_files(), bring_api(), chr2num(), db_download(), db_upload(), export_plot(), export_results(), files_functions(), font_exists(), formatColoured(), formatHTML(), get_credentials(), glued(), grepm(), h2o_selectmodel(), haveInternet(), image_metadata(), importxlsx(), ip_data(), json2vector(), list_cats(), listfiles(), mail_send(), markdown2df(), move_files(), msplit(), myip(), quiet(), read.file(), statusbar(), try_require(), updateLares(), warnifnot(), what_size()

Examples

# Basic use (global stopwatch)
tic()
Sys.sleep(0.1)
toc()

# Multiple tic tocs
tic(id = "two", quiet = FALSE)
Sys.sleep(0.2)
toc(id = "two")

# Global is still working (id = 1)
toc(msg = "The function finished its work in")

lares documentation built on Nov. 5, 2023, 1:09 a.m.