Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Package: bpmnVisualization
Type: Package
Title: Visualize Process Execution Data on BPMN (Business Process Model and Notation) Diagrams
Title: Visualize Process Execution Data on BPMN Diagrams
Version: 0.2.2.9000
Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "[email protected]"),
person("Thomas", "Bouffard", role = "aut"))
Description: To visualize the execution data of the processes on BPMN diagrams, using overlays, style customization and interactions, with BPMN Visualization.
Description: To visualize the execution data of the processes on BPMN (Business Process Model and Notation) diagrams, using overlays, style customization and interactions, with BPMN Visualization.
License: Apache License (== 2)
Copyright: Bonitasoft S.A.
URL: https://github.com/process-analytics/bpmn-visualization-R
Expand Down
2 changes: 2 additions & 0 deletions R/bpmnVisualization-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#' @keywords internal
"_PACKAGE"
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@
</div>
<br>

This project is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.
<!-- duplicated with README.md -->
`bpmnVisualization` is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.

It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provides an easy-to-use framework for bringing together R and the [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) TypeScript library.
<!-- END OF duplicated with README.md -->

## ♻️ Usage
### Installation
Expand All @@ -35,6 +37,7 @@ It can be installed from the R console:
install.packages('devtools')
```

<!-- duplicated with README.md -->
#### Install _BPMN Visualization - R Package_ from GitHub

To install a dedicated version (available versions can be found in the [GitHub releases page](https://github.com/process-analytics/bpmn-visualization-R/releases)), run:
Expand All @@ -51,6 +54,7 @@ Then, make the library available to the current R project:
```r
library(bpmnVisualization)
```
<!-- END OF duplicated with README.md -->

### Load the BPMN file
`bpmnVisualization` accepts a BPMN file (or an XML document):
Expand Down
2 changes: 2 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
template:
bootstrap: 5
52 changes: 52 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!-- This page is processed by pkgdown to create the home page of the HTML documentation -->

# BPMN Visualization - R Package

<!-- badges: start -->
[![R-CMD-check](https://github.com/process-analytics/bpmn-visualization-R/workflows/R-CMD-check/badge.svg)](https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->


<!-- duplicated with README.md -->
`bpmnVisualization` is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.

It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provides an easy-to-use framework for bringing together R and the [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) TypeScript library.
<!-- END OF duplicated with README.md -->


<!-- duplicated with README.md -->
## Installation

To install a dedicated version (available versions can be found in the [GitHub releases page](https://github.com/process-analytics/bpmn-visualization-R/releases)), run:
```r
devtools::install_github("process-analytics/[email protected]")
```

Or install the development version:
```r
devtools::install_github("process-analytics/bpmn-visualization-R")
```

Then, make the library available to the current R project:
```r
library(bpmnVisualization)
```
<!-- END OF duplicated with README.md -->


## 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.

```r
bpmnVisualization::display(bpmn_content)
```

Read `?display` for more details.


## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/process-analytics/.github/blob/main/CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.
45 changes: 17 additions & 28 deletions man/bpmnVisualization-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.