time.log: Create Time Log

In ddavid-evdy/miscR:

Description

Creates a background table for logging and reading times. This can be useful for calculating the run time of code, or particularly, for helping to estimate the time remaining in an iterative process.

Usage

time.log(action = "log", unit = "mins", comment = NULL)

Arguments

action	Character string stating the action to be performed. Accepts 3 values: "log", "return", and "clear". "log" appends the table with a new row containing the current system time, as well as calculations for iteration run time and total run time. "return" returns the log for viewing or storing as a dataframe. "clear" Clears the log.
unit	Base unit to use when measuring time. Accepts "secs", "mins", "hours", and "days".
comment	Character string containing any comment the user may want to in that line of the time log.

Value

Data frame containing times logged, stored in the background of the current instance.

ddavid-evdy/miscR documentation built on May 15, 2019, 1:49 a.m.