Using pointblank in an R Markdown workflow is enabled by default once the
pointblank library is loaded. The framework allows for validation testing
within specialized validation code chunks where the validate = TRUE
option
is set. Using pointblank validation functions on data in these
marked code chunks will flag overall failure if the stop threshold is
exceeded anywhere. All errors are reported in the validation code chunk after
rendering the document to HTML, where green or red status buttons indicate
whether all validations succeeded or failures occurred. Clicking any such
button reveals the otherwise hidden validation statements and their error
messages (if any). While the framework for such testing is set up by default,
the validate_rmd()
function offers an opportunity to set UI and logging
options.
validate_rmd(summary = TRUE, log_to_file = NULL)
If TRUE
(the default), then there will be a leading summary
of all validations in the rendered R Markdown document. With FALSE
, this
element is not shown.
An option to log errors to a text file. By default, no
logging is done but TRUE
will write log entries to
"validation_errors.log"
in the working directory. To both enable logging
and to specify a file name, include a path to a log file of the desired
name.
1-4
Other Planning and Prep:
action_levels()
,
create_agent()
,
create_informant()
,
db_tbl()
,
file_tbl()
,
scan_data()
,
tbl_get()
,
tbl_source()
,
tbl_store()