index.md

In process-analytics/bpmn-visualization-R: Visualize Process Execution Data on 'BPMN' Diagrams

bpmnVisualizationR

bpmnVisualizationR is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.

It is made possible by htmlwidgets, which provides an easy-to-use framework for bringing together R and the bpmn-visualization TypeScript library.

Installation

From CRAN

The latest stable version of the bpmnVisualizationR package can be obtained from CRAN with the command:

install.packages("bpmnVisualizationR")

From GitHub

To install a dedicated version (available versions can be found in the GitHub releases page), run:

devtools::install_github("process-analytics/bpmn-visualization-R@v0.5.0")

Or install the development version:

devtools::install_github("process-analytics/bpmn-visualization-R")

Then, make the library available to the current R project:

library(bpmnVisualizationR)

Usage

You first need to retrieve the content of the BPMN diagram. Once you are done, you can pass it to the display function that will render it.

bpmnVisualizationR::display(bpmn_content)

Read ?display for more details.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

process-analytics/bpmn-visualization-R documentation built on Jan. 25, 2025, 10:34 a.m.