Skip to content

rogiersbart/rui

Repository files navigation

rui
A simple set of UI functions

Lifecycle: experimental CRAN status

This package provides a wrapper around different cli and usethis functions, aiming at providing a small but consistent set of verbs to construct a simple R package UI.

The idea is that all of the verbs allow the use of glue strings and cli inline styles as well, to streamline the coding with rui.

Install

You can install the latest version of rui with any of the following:

renv::install("rogiersbart/rui")
pak::pkg_install("rogiersbart/rui")
remotes::install_github("rogiersbart/rui")

Use

The following internal functions can be called to get a quick overview. It is best if you try this in your own console/terminal of choice, to see if styling is supported (this should work within RStudio normally).

rui:::demo_standard_text()
rui:::demo_multi_line_feedback()
rui:::demo_single_line_feedback()
rui:::demo_user_interaction()
rui:::demo_conditions()
rui:::demo_object_inspection()

For a quick overview of the glue strings and inline cli styles, there are two more internal demo functions.

rui:::demo_glue_strings()
rui:::demo_cli_inline_styles()

Note

The package logo is a derivative of Bart RogiersCC BY 4.0-licensed espresso project.