ui | R Documentation |
These functions are used to construct the user interface of usethis. Use
them in your own package so that your use_
functions work the same way
as usethis.
The ui_
functions can be broken down into four main categories:
block styles: ui_line()
, ui_done()
, ui_todo()
, ui_oops()
,
ui_info()
.
conditions: ui_stop()
, ui_warn()
.
questions: ui_yeah()
, ui_nope()
.
inline styles: ui_field()
, ui_value()
, ui_path()
, ui_code()
,
ui_unset()
.
The question functions ui_yeah()
and ui_nope()
have their own help page.
ui_line(x = character(), .envir = parent.frame())
ui_todo(x, .envir = parent.frame())
ui_done(x, .envir = parent.frame())
ui_oops(x, .envir = parent.frame())
ui_info(x, .envir = parent.frame())
ui_code_block(x, copy = rlang::is_interactive(), .envir = parent.frame())
ui_stop(x, .envir = parent.frame())
ui_warn(x, .envir = parent.frame())
ui_silence(code)
ui_field(x)
ui_value(x)
ui_path(x, base = NULL)
ui_code(x)
ui_unset(x = "unset")
x |
A character vector. For block styles, conditions, and questions, each element of the
vector becomes a line, and the result is processed by |
.envir |
Used to ensure that |
copy |
If |
code |
Code to execute with usual UI output silenced. |
base |
If specified, paths will be displayed relative to this path. |
The block styles, conditions, and questions are called for their side-effect. The inline styles return a string.
All UI output (apart from ui_yeah()
/ui_nope()
prompts) can be silenced
by setting options(usethis.quiet = TRUE)
. Use ui_silence()
to silence
selected actions.
Other user interface functions:
ui-questions
new_val <- "oxnard"
ui_done("{ui_field('name')} set to {ui_value(new_val)}")
ui_todo("Redocument with {ui_code('devtools::document()')}")
ui_code_block(c(
"Line 1",
"Line 2",
"Line 3"
))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.