@eagleoutice/flowr v2.2.15

\

flowR is a sophisticated, static dataflow analyzer for the R programming language, available for VSCode, Positron, RStudio, and Docker. It offers a wide variety of features, for example:

• 🍕 program slicing\ Given a point of interest like the visualization of a plot, flowR reduces the program to just the parts which are relevant for the computation of the point of interest.

• 📚 dependency analysis\ Given your analysis project, flowR offers a plethora of so-called queries to get more information about your code. An important query is the dependencies query, which shows you the library your project needs, the data files it reads, the scripts it sources, and the data it outputs.

• 🚀 fast data- and control-flow graphs\ Within just 133.8 ms (as of May 31, 2025), flowR can analyze the data- and control-flow of the average real-world R script. See the benchmarks for more information, and consult the wiki pages for more details on the dataflow graph.

If you want to use flowR and the features it provides, feel free to check out the:

• Visual Studio Code/Positron: provides access to flowR directly in VS Code and Positron (or vscode.dev)
• RStudio Addin: integrates flowR into RStudio
• R package: use flowR in your R scripts
• Docker image: run flowR in a container, this also includes flowR's server

• NPM package: include flowR in your TypeScript and JavaScript projects

If you are already using flowR and want to give feedback, please consider filling out our feedback form.

⭐ Getting Started

To get started with flowR and its features, please check out the Overview wiki page. The Setup wiki page explains how you can download and setup flowR on your system. With docker 🐳️, the following line should be enough (and drop you directly into the read-eval-print loop):

docker run -it --rm eagleoutice/flowr

You can enter :help to gain more information on its capabilities.

📜 More Information

For more details on how to use flowR please refer to the wiki pages, as well as the deployed code documentation.

🚀 Contributing

We welcome every contribution! Please check out the developer onboarding section in the wiki for all the information you will need.

Contributors

flowr is actively developed by Florian Sihler under the GPLv3 License.\ It is partially supported by the German Research Foundation (DFG) under the grant 504226141 ("CodeInspector").

Generation Notice

Please notice that this file was generated automatically using the file src/documentation/print-readme.ts as a source.\ If you want to make changes please edit the source file (the CI will take care of the rest). In fact, many files in the wiki are generated, so make sure to check for the source file if you want to make changes.