with_verbosity: Run code with verbosity

In uncoast-unconf/steward: Helps you manage metadata for published datasets

Description

Use these functions to wrap code in a verbosity option. You can wrap blocks of code using with_verbosity(); you can use the adverb verbosely() to modify another function so it acts with verbosity.

Usage

with_verbosity(verbosity = c("error", "info", "all", "none"), code)

verbosely(.f, verbosity = c("error", "info", "all", "none"))

Arguments

verbosity	character value to set for verbosity option
code	Code to be run using the verbosity option
.f	function to wrap using verbosity

Details

Keep in mind that only the "closest" invocation to the code will be effective; the allowable values for verbosity are:

"error"

reports results of all checks that failed

"info"

reports results of all checks that failed, and that find missing optional information

"all"

reports results of all checks

"none"

reports no results

TODO: talk about implementation, steward.verbosity

Value

with_verbosity

The results of the evaluation of the code argument.

verbosely

function with same arguments as .f, which will run using the verbosity argument

Examples

with_verbosity("all", stw_meta(diamonds_meta))
verbosely(stw_meta, "all")(diamonds_meta)
diamonds_meta %>% verbosely(stw_meta, "all")()

uncoast-unconf/steward documentation built on Jan. 7, 2021, 10:38 a.m.