flow_test: Build Report From Tests

View source: R/08_flow_test.R

flow_testR Documentation

Build Report From Tests

Description

Build a markdown report from test scripts, showing the paths taken in tested functions, and where they fail if they do. See also the vignette "Build reports to document functions and unit tests".

Usage

flow_test(
  prefix = NULL,
  code = TRUE,
  narrow = FALSE,
  truncate = NULL,
  swap = TRUE,
  out = NULL,
  failed_only = FALSE
)

Arguments

prefix

prefix to use for special comments in our code used as block headers, must start with "#", several prefixes can be provided

code

Whether to display the code in code blocks or only the header, to be more compact, if NA, the code will be displayed only if no header is defined by special comments

narrow

TRUE makes sure the diagram stays centered on one column (they'll be longer but won't shift to the right)

truncate

maximum number of characters to be printed per line

swap

whether to change var <- if(cond) expr into if(cond) var <- expr so the diagram displays better

out

path to output (.html or .md), if left NULL a temp html file will be created and opened.

failed_only

whether to restrict the report to failing tests only

Value

Returns NULL invisibly (called for side effects)


flow documentation built on March 18, 2022, 6:22 p.m.