https://github.com/moodymudskipper/flow
View and Browse Code Using Flow Diagrams
https://github.com/moodymudskipper/flow
Last synced: 10 days ago
JSON representation
View and Browse Code Using Flow Diagrams
- Host: GitHub
- URL: https://github.com/moodymudskipper/flow
- Owner: moodymudskipper
- License: other
- Created: 2019-10-15T08:15:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-13T01:32:19.000Z (over 1 year ago)
- Last Synced: 2024-04-25T11:03:31.555Z (12 months ago)
- Language: R
- Homepage: https://moodymudskipper.github.io/flow/
- Size: 25.3 MB
- Stars: 389
- Watchers: 16
- Forks: 26
- Open Issues: 55
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - moodymudskipper/flow - View and Browse Code Using Flow Diagrams (R)
README
---
output: github_document
---
[](https://github.com/moodymudskipper/flow/actions)
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# flow 
*{flow}* provides tools to visualize as flow diagrams the logic of functions,
expressions or scripts and ease debugging.
Use cases are :
* Deciphering other people's code
* Getting more comfortable with our own code by easing a visual understanding of its structure
* Documentation
* Debugging
* Inspect unit test results
* Providing a higher level view of an algorithm to collaborators
* Education
## Installation
Install from CRAN with:
``` r
install.packages("flow")
```
Or install development version from github:
``` r
remotes::install_github("moodymudskipper/flow")
```
## Example
```{r, eval=TRUE}
library(flow)
```
Using default nomnoml engine
```{r, eval=FALSE}
flow_view(rle)
```
Using plantuml engine (make sure the [{plantuml}](https://github.com/rkrug/plantuml) package is installed).
```{r, eval=FALSE}
flow_view(rle, engine = "plantuml")
```
## Additional functions
* `flow_run()` to display not only the diagram, but the logical path taken by a specific call
* `flow_compare_runs()` display the logical path of 2 calls to see where they diverge
* `flow_debug()`/`flow_undebug()` to use basically use `flow_run()` on a function wherever it's called
* `flow_view_vars()` to display the dependencies between variables in a function
* `flow_view_deps()` to display recursively all the functions that your function calls
* `flow_view_uses()` to display recursively all the functions that call your function
* `flow_view_shiny()` to display the modular structure of your shiny app
* `flow_view_source_calls()` to display dependency tree of scripts sourcing each other
* `flow_doc()` to build a package's documentation using flow diagrams
* `flow_test()` to show what happens in your unit tests
* `flow_embed()` to embed diagrams in your documentation.
See more in vignettes.
## Notes
Make sure to check the vignettes for a detailed breakdown of all features.
*{flow}* is built on top of Javier Luraschi's *{nomnoml}* package, and
Rainer M Krug 's *{plantuml}* package, the latter only available from
[github](https://github.com/rkrug/plantuml)
at the moment.