Skip to content

Commit

Permalink
doc-fix: adjust links; fix conflicts; inflate stats
Browse files Browse the repository at this point in the history
  • Loading branch information
bjthehun committed Mar 22, 2024
1 parent c84cc26 commit 46e5da0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions wiki/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,19 @@ flowchart TD
click slice href "https://github.com/Code-Inspect/flowr/tree/main/src/slicing" "Jump to the Implementation"
click rc href "https://github.com/Code-Inspect/flowr/blob/main/src/reconstruct/reconstruct.ts" "Jump to the Implementation"
click core href "https://github.com/Code-Inspect/flowr/blob/main/src/core" "Jump to the Implementation"
click benchmark href "https://github.com/Code-Inspect/flowr/tree/main/benchmark" "Jump to the Implementation"
click stat href "https://github.com/Code-Inspect/flowr/tree/main/statistics" "Jump to the Implementation"
click utility href "https://github.com/Code-Inspect/flowr/tree/main/util" "Jump to the Implementation"
click benchmark href "https://github.com/Code-Inspect/flowr/tree/main/benchmark/src" "Jump to the Implementation"
click stat href "https://github.com/Code-Inspect/flowr/tree/main/statistics/src" "Jump to the Implementation"
click utility href "https://github.com/Code-Inspect/flowr/tree/main/src/util" "Jump to the Implementation"
```

The [mermaid](https://mermaid.js.org/) diagram above presents the architecture of *flowR*, with the important components directly related to the actual slicing highlighted accordingly (all boxes should be hyperlinks to the corresponding implementation *if* you are interested - depending on your browser you may have to specifically open them in a new tab).

Primarily, *flowR* provides a backward [program slicer](https://en.wikipedia.org/wiki/Program_slicing) for the [*R*](https://www.r-project.org/) programming language, which is available with the corresponding [slicer](https://github.com/Code-Inspect/flowr/tree/main/src/slicing) module and exposed by the [`slicer`](#generate-static-slices) script.
Its subcomponents (like the custom [R bridge](https://github.com/Code-Inspect/flowr/tree/main/src/r-bridge) or the static [dataflow analysis]("https://github.com/Code-Inspect/flowr/tree/main/src/dataflow)) are not important if you simply wish to use *flowR*.

The [benchmarker](https://github.com/Code-Inspect/flowr/tree/main/benchmark) module is only of interest if you want to benchmark/measure the runtime performance and reduction of the slicer. It is available with the [`benchmark`](#benchmark-the-slicer) script.
The [benchmarker](https://github.com/Code-Inspect/flowr/tree/main/benchmark/src) module is only of interest if you want to benchmark/measure the runtime performance and reduction of the slicer. It is available with the [`benchmark`](#benchmark-the-slicer) script.

The [statistics](https://github.com/Code-Inspect/flowr/tree/main/statistics) module is mostly independent of the slicer and can be used to analyze R files regarding their use of function definitions, assignments, and more. It is used to identify common patterns in R code and is available with the [`statistics`](#generate-usage-statistics-of-r-code) script.
The [statistics](https://github.com/Code-Inspect/flowr/tree/main/statistics/src) module is mostly independent of the slicer and can be used to analyze R files regarding their use of function definitions, assignments, and more. It is used to identify common patterns in R code and is available with the [`statistics`](#generate-usage-statistics-of-r-code) script.

The [core](https://github.com/Code-Inspect/flowr/tree/main/src/core) module contains *flowR*'s read-eval-print loop (REPL) and *flowR*'s server. Furthermore, it contains the root definitions of how *flowR* slices (see the [interface](https://github.com/Code-Inspect/flowr/wiki/Interface) wiki page for more information).

Expand Down

0 comments on commit 46e5da0

Please sign in to comment.