flow_doc {flow}

Draw Flow Diagrams for an Entire Package

Description

Draw Flow Diagrams for an Entire Package

Usage

flow_doc(
  pkg = NULL,
  prefix = NULL,
  code = TRUE,
  narrow = FALSE,
  truncate = NULL,
  swap = TRUE,
  out = NULL,
  engine = c("nomnoml", "plantuml")
)

Arguments

pkg

package name as a string, or NULL to signify currently developed package.

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 html output, if left NULL a temp html file will be created and opened

engine

either "nomnoml" (default) or "plantuml" (experimental, brittle mostly for reasons out of our control), if the latter, arguments prefix, narrow, and code are ignored

Value

Returns NULL invisibly (called for side effects).