printf {mlr3misc} | R Documentation |
Functions for Formatted Output and Conditions
Description
catf()
, messagef()
, warningf()
and stopf()
are wrappers around base::cat()
,
base::message()
, base::warning()
and base::stop()
, respectively.
Usage
catf(msg, ..., file = "", wrap = FALSE)
messagef(msg, ..., wrap = FALSE, class = NULL)
warningf(msg, ..., wrap = FALSE, class = NULL)
stopf(msg, ..., wrap = FALSE, class = NULL)
Arguments
msg |
( |
... |
( |
file |
( |
wrap |
( |
class |
( |
Details
For leanified R6 classes, the call included in the condition is the method call and not the call into the leanified method.
Errors and Warnings
Errors and warnings get the classes mlr3{error, warning}
and also inherit from
simple{Error, Warning}
.
It is possible to give errors and warnings their own class via the class
argument.
Doing this, allows to suppress selective conditions via calling handlers, see e.g.
globalCallingHandlers
.
When a function throws such a condition that the user might want to disable, a section Errors and Warnings should be included in the function documention, describing the condition and its class.
Examples
messagef("
This is a rather long %s
on multiple lines
which will get wrapped.
", "string", wrap = 15)