Setup

To use flowR, you need R installed and on your path. Although there are several ways to do so, there is nothing wrong with installing R with the help of your favorite package manager or directly from the website.^<1>

Furthermore, you need the node package manager (for Linux, we recommend using nvm).

After cloning the repository, you can install the dependencies with:

npm i

After that, you should be fine! You may test flowR by running:

npm run slicer -- --criterion "12@product" test/testfiles/example.R

The output should look similar to this:

product <- 1
N <- 10
for(i in 1:(N-1)) product <- product * i
cat("Product:", product, "\n")

At the time of writing this, there is currently no page for frequently encountered errors. So just message me in case of problems.

Developing for flowR

If you want to develop for flowR, please refer to the CONTRIBUTING.md in the repository.

---

<1>: Currently, flowR is only tested with R version 4.3.1 (2023-06-16) -- "Beagle Scouts"