addToTimingsTable: Time steps in a script

In ivanliu1989/RQuant: A collection of generic functions

Description

This function allows you to track the time it takes to run different steps in a script / function / etc.

Usage

addToTimingsTable(entryName = "Start", timingsTable = NULL, printMsg = F,
  printTime = F)

Arguments

entryName	The Step to be run
timingsTable	A timingsTable to be added to
printMsg	Whether or not the entryName should be printed to the screen

Value

A data frame containing the tasks performed and when they were started. If timingsTable is provided then this Will be appended to.

Examples

# Standard Usage
timingsTable = addToTimingsTable("Start")

# print out the msg
timingsTable = addToTimingsTable("Start", NULL, T)

# Multiple steps
timingsTable = addToTimingsTable("Start")
timingsTable = addToTimingsTable("Another Step", timingsTable)

ivanliu1989/RQuant documentation built on Sept. 13, 2019, 11:53 a.m.