The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Title: Create and Manage Configuration Profiles
Version: 0.0.1
Description: A toolbox to create and manage metadata files and configuration profiles: files used to configure the parameters and initial settings for some computer programs.
License: MIT + file LICENSE
URL: https://github.com/jeanmathieupotvin/dotprofile
BugReports: https://github.com/jeanmathieupotvin/dotprofile/issues/new
ByteCompile: true
Encoding: UTF-8
Language: en
NeedsCompilation: no
RoxygenNote: 7.1.2
Depends: R (≥ 4.1.0)
Imports: R6, cli (≥ 3.1.0)
Suggests: microbenchmark, covr, withr, testthat (≥ 3.0.0)
Config/testthat/edition: 3
Config/testthat/parallel: true
Packaged: 2021-11-23 14:48:52 UTC; jmp
Author: Jean-Mathieu Potvin ORCID iD [aut, cre]
Maintainer: Jean-Mathieu Potvin <jm@potvin.xyz>
Repository: CRAN
Date/Publication: 2021-11-23 19:30:04 UTC

dotprofile: create and manage configuration profiles

Description

A toolbox to create and manage metadata files and configuration profiles: files used to configure the parameters and initial settings for some computer programs.

Author(s)

Maintainer: Jean-Mathieu Potvin jm@potvin.xyz (ORCID)

See Also

Useful links:


User interface of dotprofile

Description

These functions are used to construct the command-line interface of dotprofile. They are inspired from usethis for consistency, but their implementation is different and relies on wrapper functions to other functions of cli.

Usage

## ---
## Print messages to the console
## ---

ui_todo(..., .envir = parent.frame())

ui_info(..., .envir = parent.frame())

ui_done(..., .envir = parent.frame())

ui_nope(..., .envir = parent.frame())

ui_ask(..., .envir = parent.frame())

## ---
## Ask for inputs interactively
## ---

ui_input(..., .envir = parent.frame())

ui_menu(..., answers = c("yes", "no"), .envir = parent.frame())

## ---
## Signal conditions
## ---

ui_warn(warning, ..., .envir = parent.frame())

ui_stop(error, ..., .envir = parent.frame())

## ---
## Cheatsheet for inline markup
## ---

ui_theme()

Arguments

...

⁠[any]⁠

Passed to cli::format_inline(), unless stated otherwise below. Use cli inline markup for inline formatting.

Functions ui_warn() and ui_stop()

... is an optional sequence of further calls executed after returning a message via base::warning() and base::stop() respectively. You should only pass calls to other user interface functions. See examples below.

.envir

⁠[environment]⁠

Passed to cli::format_inline(), cli::format_warning() or cli::format_error(). This argument is not validated by dotprofile and is reserved for expert use.

answers

⁠[atomic]⁠

Non-empty atomic vector passed to argument choices of utils::menu().

warning

⁠[character(1)]⁠

Passed to cli::format_warning().

error

⁠[character(1)]⁠

Passed to cli::format_error().

Details

The user interface functions of dotprofile can be divided into three groups.

  1. Print messages with ui_todo(), ui_info(), ui_done(), ui_warn(), ui_ask() and ui_nope().

  2. Seek answers from the user with ui_input() and ui_menu(). The former expects an input to be typed in the terminal, while the latter expects a value to be chosen interactively from a menu. These functions can only be used in an interactive session.

  3. Signal conditions with ui_warn() and ui_stop(). They are designed to play nicely with ⁠ui_*()⁠ functions of the first group, and can be used to craft beautiful and meaningful error messages.

All functions support string interpolation.

Value

Examples

## Use dotprofile's UI functions to convey messages to the user.
ui_examples <- function()
{
    ui_todo("This is a {.strong to-be-completed} task.")
    ui_info("This is an information.")
    ui_done("This a {.strong completed} task.")
    ui_nope("Something's {.strong wrong}, but this is not an error.")
    ui_ask("This is a question.")
}

ui_examples()

## Use cli's inline classes to easily style messages passed to `...`
ui_theme()

## Construct beautiful warnings and errors with ui_warn() and ui_stop().
## Not run: 
  ui_warn("this is a warning message generated with {.fn ui_warn}.")
  ui_warn("this is a {.emph super custom} warning message.",
      ui_info("You can pass other {.fn ui_*} calls to it."),
      ui_info("They are printed after the warning message, like {.pkg rlang} does."),
      ui_nope("Only use functions that has side-effects here.")
  )

  ui_stop("this is an error message generated with {.fn ui_stop}.")
  ui_stop("this is a {.emph super custom} error message.",
      ui_info("You can pass other {.fn ui_*} calls to it."),
      ui_info("They are printed after the error message, like {.pkg rlang} does."),
      ui_nope("Only use functions that has side-effects here.")
  )
## End(Not run)

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.