console: The console API
In rogiersbart/rui: A simple set of UI functions
console R Documentation
The console API
Description
This function provides an alternative to the verb-based API, by mapping the
set of prefixes to the corresponding verbs.
Usage
console(..., object = NULL, levels = 1, .envir = parent.frame())
Arguments
...
Character vectors supporting glue strings and cli inline
styles. This should start with a supported prefix, to map the action to one
of the rui verbs. Otherwise, rui::tell() is used. Supported prefixes are(entitle), i (inform), v (approve), x (disapprove), ~ (begin/proceed), =
(give), * (suggest), ? (ask), ! (alert), w (warn), e (stop), . (display), and
$ (expose). Status bars can be resolved by providing single characters "c",
"v", or "x" for clear, succeed and fail respectively.
object
Object to print the rui way through rui::inspect().
rogiersbart/rui documentation built on June 28, 2024, 7:35 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| console | R Documentation |
The console API
Description
This function provides an alternative to the verb-based API, by mapping the set of prefixes to the corresponding verbs.
Usage
console(..., object = NULL, levels = 1, .envir = parent.frame())
Arguments
... |
Character vectors supporting glue strings and cli inline
styles. This should start with a supported prefix, to map the action to one
of the rui verbs. Otherwise, (give), * (suggest), ? (ask), ! (alert), w (warn), e (stop), . (display), and $ (expose). Status bars can be resolved by providing single characters "c", "v", or "x" for clear, succeed and fail respectively. |
object |
Object to print the rui way through |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.