flow_doc | R Documentation |
Draw Flow Diagrams for an Entire Package
flow_doc( pkg = NULL, prefix = NULL, code = TRUE, narrow = FALSE, truncate = NULL, swap = TRUE, out = NULL, engine = c("nomnoml", "plantuml") )
pkg |
package name as a string |
prefix |
prefix to use for special comments in our code used as block headers,
must start with |
code |
Whether to display the code in code blocks or only the header,
to be more compact, if |
narrow |
|
truncate |
maximum number of characters to be printed per line |
swap |
whether to change |
out |
path to output ( |
engine |
either |
if pkg
and out
are both left NULL
, a vignette diagrams.md
will be built
in the root, so that pkgdown::build_site
will use it as an additional page.
See also the vignette "Build reports to document functions and unit tests".
Returns NULL
invisibly (called for side effects).
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.