This family has a consistent use of verbose
allowing messages to be
turned on or off or verbosity increased or decreased throughout the family of
messaging in reproducible
.
messageDF(
df,
round,
colour = NULL,
colnames = NULL,
indent = NULL,
verbose = getOption("reproducible.verbose"),
verboseLevel = 1,
appendLF = TRUE
)
messagePrepInputs(
...,
appendLF = TRUE,
verbose = getOption("reproducible.verbose"),
verboseLevel = 1
)
messagePreProcess(
...,
appendLF = TRUE,
verbose = getOption("reproducible.verbose"),
verboseLevel = 1
)
messageCache(
...,
colour = getOption("reproducible.messageColourCache"),
verbose = getOption("reproducible.verbose"),
verboseLevel = 1,
appendLF = TRUE
)
messageQuestion(..., verboseLevel = 0, appendLF = TRUE)
.messageFunctionFn(
...,
appendLF = TRUE,
verbose = getOption("reproducible.verbose"),
verboseLevel = 1
)
messageColoured(
...,
colour = NULL,
indent = NULL,
hangingIndent = TRUE,
verbose = getOption("reproducible.verbose", 1),
verboseLevel = 1,
appendLF = TRUE
)
A data.frame, data.table, matrix
An optional numeric to pass to round
Any colour that can be understood by cli
Logical or NULL
. If TRUE
, then it will print
column names even if there aren't any in the df
(i.e., they will)
be V1
etc., NULL
will print them if they exist, and FALSE
which will omit them.
An integer, indicating whether to indent each line
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., options('reproducible.verbose' = 0) to reduce to minimal
The numeric value for this message*
call, equal or above
which verbose
must be. The higher this is set, the more unlikely the call
will show a message.
logical: should messages given as a character string have a newline appended?
Any character vector, passed to paste0(...)
Logical. If there are \n
, should there be a handing indent of 2 spaces.
Default is TRUE
Used for side effects. This will produce a message of a structured data.frame
.
messageDF
uses message
to print a clean square data structure.
messageColoured
allows specific colours to be used.
messageQuestion
sets a high level for verbose
so that the message always gets asked.