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".
flow_test(
prefix = NULL,
code = TRUE,
narrow = FALSE,
truncate = NULL,
swap = TRUE,
out = NULL,
failed_only = FALSE
)
prefix to use for special comments in our code used as block headers,
must start with "#"
, several prefixes can be provided
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
TRUE
makes sure the diagram stays centered on one column
(they'll be longer but won't shift to the right)
maximum number of characters to be printed per line
whether to change var <- if(cond) expr
into
if(cond) var <- expr
so the diagram displays better
path to html output, if left NULL
a temp html
file will be created and opened.
whether to restrict the report to failing tests only
Returns NULL
invisibly (called for side effects)