NCmisc (version 1.2.0)

timeit: Times an expression, with breakdown of time spent in each function !DEPRECATED October 14, 2022!

Description

A wrapper for the proftools package Rprof() function. It is to Rprof() as system.time() is to proc.time() (base) Useful for identifying which functions are taking the most time. This procedure will return an error unless expr takes more than ~0.1 seconds to evaluate. I could not see any simple way to avoid this limitation. Occassionally other errors are produced for no apparent reason which are due to issues within the proftools package that are out of my control.

Usage

timeit(expr, suppressResult = F, total.time = TRUE)

Value

returns matrix where rows are function names, and columns are self.time and total.time. total.time is total time spent in that function, including function calls made by that function. self.time doesn't count other functions within a function

Arguments

expr

an expression, must take at least 1 second (roughly)

suppressResult

logical, if true, will return timing information rather than the result of expr

total.time

to sort by total.time, else by self.time

Author

Nicholas Cooper

Examples

# this function writes and removes a temporary file
# run only if ok to do this in your temporary directory
#not run# timeit(wait(0.1,"s") ,total.time=TRUE)
#not run# timeit(wait(0.1,"s") ,total.time=FALSE)