messageDF

Sends to <code>message</code>, but in a structured way so that a data.frame-like can
be cleanly sent to messaging.

A collection of high-level, machine- and OS-independent tools
for making deeply reproducible and reusable content in R.
The two workhorse functions are 'Cache()' and 'prepInputs()'. `Cache()`
allows for nested caching, is robust to environments and objects with
environments (like functions), and has deals with some classes of
file-backed R objects e.g., from `terra` and `raster` packages.
Both functions have been developed to
be foundational components of data retrieval
and processing in continuous workflow situations. In both functions,
efforts are made to make the first and subsequent calls of functions have
the same result, but faster at subsequent times by way of checksums
and digesting. Several features are still under development, including
cloud storage of cached objects, allowing for sharing between users. Several
advanced options are available, see '?reproducibleOptions()'.

Eliot J B

reproducible

A Set of Tools that Enhance Reproducibility of R Code

Eliot J B McIntire

Alex M Chubaty

Tati Micheletti

Ceres Barros

Ian Eddy

His Majesty the King in Right of Canada, as represented by the Minister of Natural Resources Canada 

messageDF function

<dl><dt>df</dt>
<dd>A data.frame, data.table, matrix</dd>
<dt>round</dt>
<dd>An optional numeric to pass to <code>round</code></dd>
<dt>colour</dt>
<dd>Passed to <code>getFromNamespace(colour, ns = "crayon")</code>,
so any colour that <code>crayon</code> can use</dd>
<dt>colnames</dt>
<dd>Logical or <code>NULL</code>. If <code>TRUE</code>, then it will print
column names even if there aren't any in the <code>df</code> (i.e., they will)
be <code>V1</code> etc., <code>NULL</code> will print them if they exist, and <code>FALSE</code>
which will omit them.</dd>
<dt>appendLF</dt>
<dd>logical: should messages given as a character string
 have a newline appended?</dd>
<dt>verbose</dt>
<dd>Numeric, -1 silent (where possible), 0 being very quiet,
1 showing more messaging, 2 being more messaging, etc.
Default is 1. Above 3 will output much more information about the internals of
Caching, which may help diagnose Caching challenges. Can set globally with an
option, e.g., <code>options('reproducible.verbose' = 0) to reduce to minimal</code></dd>
<dt>verboseLevel</dt>
<dd>The numeric value for this <code>message*</code> call, equal or above
which <code>verbose</code> must be. The higher this is set, the more unlikely the call
will show a message.</dd></dl>

Arguments

Use message to print a clean square data structure — messageDF

<dl>

<dt>df</dt>
<dd>A data.frame, data.table, matrix</dd>


<dt>round</dt>
<dd>An optional numeric to pass to <code>round</code></dd>


<dt>colour</dt>
<dd>Passed to <code>getFromNamespace(colour, ns = "crayon")</code>,
so any colour that <code>crayon</code> can use</dd>


<dt>colnames</dt>
<dd>Logical or <code>NULL</code>. If <code>TRUE</code>, then it will print
column names even if there aren't any in the <code>df</code> (i.e., they will)
be <code>V1</code> etc., <code>NULL</code> will print them if they exist, and <code>FALSE</code>
which will omit them.</dd>


<dt>appendLF</dt>
<dd>logical: should messages given as a character string
 have a newline appended?</dd>


<dt>verbose</dt>
<dd>Numeric, -1 silent (where possible), 0 being very quiet,
1 showing more messaging, 2 being more messaging, etc.
Default is 1. Above 3 will output much more information about the internals of
Caching, which may help diagnose Caching challenges. Can set globally with an
option, e.g., <code>options('reproducible.verbose' = 0) to reduce to minimal</code></dd>


<dt>verboseLevel</dt>
<dd>The numeric value for this <code>message*</code> call, equal or above
which <code>verbose</code> must be. The higher this is set, the more unlikely the call
will show a message.</dd>

</dl>

messageDF: Use message to print a clean square data structure

Description

Usage

Value

Arguments