flowengineR/README.Rmd at main · mwiller1991/flowengineR · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
output: github_document
---

# flowengineR

[![R-CMD-check](https://github.com/mwiller1991/flowengineR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mwiller1991/flowengineR/actions/workflows/R-CMD-check.yaml)

`flowengineR` is an R package for defining and running modular workflows, including fairness-aware preprocessing, in-processing, and post-processing options.

---

## ✨ Features

- Modular architecture with interchangeable engines
- Control-based configuration interface
- Fairness integration at all pipeline levels
- Support for batchtools and adaptive execution
- Integrated reporting and publishing engines
- LLM-assisted engine builder for rapid prototyping of new engines

---

## 🚀 Installation

```r
# Install from GitHub
install.packages("devtools")
devtools::install_github("mwiller1991/flowengineR", build_vignettes = TRUE)
library(flowengineR)
```

---

## 🧪 Example

```r
control <- list()

results <- run_workflow(control)
```

---

## 📚 Learn more

Check out the vignettes for detailed examples and explanations:

- Index Vignette for flowengineR
- Getting Started with flowengineR
- Why flowengineR had to be built
- End-to-End Workflow Example
- How to Build Custom Engines
- How to Use the LLM-Assisted Engine Builder
- …and many more

You can view them in R using:

```r
browseVignettes("flowengineR")

vignette("index", package = "flowengineR")
vignette("getting_started", package = "flowengineR")
vignette("why_flowengineR", package = "flowengineR")
vignette("example_workflow_credit", package = "flowengineR")

?run_workflow
```

---

## 📄 License

MIT © [Maximilian Willer](mailto:willer.maximilian@googlemail.com) and Peter Ruckdeschel

For full license terms, see the LICENSE file in this repository.