helpers: RLumBuild Helper Functions

helpersR Documentation

RLumBuild Helper Functions

Description

Helper functions which are used internally to visualise the console output. Those functions are not in the overview, but are, however, documented

Usage

.running(text = "")

.success(text = "")

.failure(text = "")

.neutral(text = "")

.shut_up(expr)

.run_module(text = "", f = NULL, shut_up = TRUE)

.get_pkg_name()

.get_pkg_version()

Arguments

text

character (with default): text to display in the terminal

expr

expression (required): R expression to be excecuted in silence, the results is piped through and the output muted (messages, warnings and usual terminal prints). Errors are returned.

shut_up

logical (with default): enables/disables shut_up mode

Author(s)

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) , RLum Developer Team


R-Lum/RLumBuild documentation built on Feb. 14, 2024, 1:17 a.m.