Build reports to document functions and unit tests

  collapse = TRUE,
  comment = "#>"


The flow_doc() function provides a way to draw all the functions of a package and store them in an html report.

The pkg argument can be any package name, from base R, CRAN, or other including your local packages.

The out argument must be a path to an html or md file.

If pkg is provided but out is left NULL, the report will be printed to a temporary file and will be opened automatically.

If you don't provide neither pkg nor out, a file will be created at the root of your project folder, so that you can use pkgdown::build_site to knit it into a new section after editing the YAML file properly.

The Diagrams section of the website was built this way, simply by using the following call :

flow_doc(prefix = "##")

And the _pkgdown.yml file that is created by usethis::use_pkgdown() is edited to contain :

    left:  [home, reference, articles, news, diagrams]
    right: [github]
    home: ~
     text: Diagrams
     href: diagrams.html


If you're using the package {testthat} for your unit tests, flow_test() will help you explore them.


Below I ran flow::flow_test() after opening the project of my package {unglue}.

It built a report with a tab for each test file, then next to the code of each script we're able to visualize the diagram of our package's functions and the logical path taken by the code, so we can easily see what was tested and what potentially went wrong.

Successful tests are showed in green, while failed ones (none in the example above) will be shown in red. To show only the failed tests, set the argument failed_only to TRUE.

If its out parameter is left NULL, the report will be printed to a temporary file and will be opened automatically.

Other parameters are forwarded to flow_run().

Try the flow package in your browser

Any scripts or data that you put into this service are public.

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