params

parameters

arguments

args

Default parameter descriptions which may be overridden in individual
functions.

internal

Tracks elapsed clock time using a `hms::hms()` scalar.
It was was originally developed to time Bayesian model runs.
It should not be used to estimate how long extremely fast code takes to execute
as the package code adds a small time cost.

Joe Thorley

hmstimer

'hms' Based Timer

Kirill Müller

Nadine Hussein

Poisson Consulting 

params function

<dl><dt>...</dt>
<dd>These dots are for future extensions and must be empty.</dd>
<dt>code</dt>
<dd>A line or block of R code.</dd>
<dt>digits</dt>
<dd>A count of the number of decimal places.</dd>
<dt>print_title</dt>
<dd>A flag specifying whether to print the title.</dd>
<dt>seconds</dt>
<dd>A non-negative numeric scalar of the initial number of seconds.</dd>
<dt>srcref</dt>
<dd>A flag specifying whether to print the source reference.</dd>
<dt>start</dt>
<dd>A flag specifying whether to start the timer.</dd>
<dt>title</dt>
<dd>A string of the title.</dd>
<dt>value</dt>
<dd>A string of the title.</dd>
<dt>x</dt>
<dd>A <code>hms_timer()</code>.</dd>
<dt>.local_envir</dt>
<dd>The environment to use for scoping.</dd></dl>

Arguments

Parameter Descriptions — params

<dl>

<dt>...</dt>
<dd>These dots are for future extensions and must be empty.</dd>


<dt>code</dt>
<dd>A line or block of R code.</dd>


<dt>digits</dt>
<dd>A count of the number of decimal places.</dd>


<dt>print_title</dt>
<dd>A flag specifying whether to print the title.</dd>


<dt>seconds</dt>
<dd>A non-negative numeric scalar of the initial number of seconds.</dd>


<dt>srcref</dt>
<dd>A flag specifying whether to print the source reference.</dd>


<dt>start</dt>
<dd>A flag specifying whether to start the timer.</dd>


<dt>title</dt>
<dd>A string of the title.</dd>


<dt>value</dt>
<dd>A string of the title.</dd>


<dt>x</dt>
<dd>A <code>hms_timer()</code>.</dd>


<dt>.local_envir</dt>
<dd>The environment to use for scoping.</dd>

</dl>

params: Parameter Descriptions

Description

Arguments

Details