toc: End tic/toc function

In ssaxe-usgs/saxy: Misc Functions

Description

Ending function for tic/toc timing sequence. Requires the tic function to have been run first. Can be run in series based on original tic function product.

Usage

toc(LS = NULL, end = FALSE, return.value = FALSE)

Arguments

LS	Character; Optional leading string to be included to annotate different timesteps. Default is NULL.
end	Logical; If TRUE, end timing sequence, deletes tic() initialization. Defaults to FALSE.
return.value	Logical; If TRUE, function returns elapsed time value in numeric format for use. Defaults to FALSE. Units in seconds.

Value

Calculate time change since initializing tic function.

Examples

tic()
toc()

ssaxe-usgs/saxy documentation built on May 31, 2019, 11:45 p.m.