single-line-feedback: Provide single-line feedback

single-line-feedbackR Documentation

Provide single-line feedback

Description

These functions provide a way to provide single-line feedback. This is typically useful for longer tasks with different subtasks, for which there is no important information that should persist in the console for the user to refer back to (e.g. downloads, optimization, running an external code that doesn't output important information). Use

  • rui::begin() to begin a task,

  • rui::proceed() to proceed with another task,

  • for ending the single-line feedback, any of

    • rui::succeed() for succesful completion,

    • rui::fail() for unsuccesful completion, and

    • rui::clear() to remove the feedback line.

Usage

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

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

clear(.envir = parent.frame())

succeed(.envir = parent.frame())

fail(.envir = parent.frame())

update(...)

end(...)

Arguments

...

Character vectors supporting glue strings and cli inline styles.

See Also

glue::glue(), cli::inline-markup


rogiersbart/rui documentation built on June 28, 2024, 7:35 a.m.