diff --git a/DESCRIPTION b/DESCRIPTION index aec30ec..e73abae 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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 = "process.analytics.dev+CRAN@gmail.com"), 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 diff --git a/R/bpmnVisualization-package.R b/R/bpmnVisualization-package.R new file mode 100644 index 0000000..0cc9deb --- /dev/null +++ b/R/bpmnVisualization-package.R @@ -0,0 +1,2 @@ +#' @keywords internal +"_PACKAGE" diff --git a/README.md b/README.md index 6367ff2..da108a6 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,11 @@
-This project is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions. + +`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. + ## ♻️ Usage ### Installation @@ -35,6 +37,7 @@ It can be installed from the R console: install.packages('devtools') ``` + #### 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: @@ -51,6 +54,7 @@ Then, make the library available to the current R project: ```r library(bpmnVisualization) ``` + ### Load the BPMN file `bpmnVisualization` accepts a BPMN file (or an XML document): diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..ec0a740 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,2 @@ +template: + bootstrap: 5 diff --git a/index.md b/index.md new file mode 100644 index 0000000..abe1eac --- /dev/null +++ b/index.md @@ -0,0 +1,52 @@ + + +# BPMN Visualization - R Package + + +[![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) + + + + +`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. + + + + +## 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/bpmn-visualization-R@v0.2.2") +``` + +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) +``` + + + +## 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. diff --git a/man/bpmnVisualization-package.Rd b/man/bpmnVisualization-package.Rd index 5e434ae..7dff21f 100644 --- a/man/bpmnVisualization-package.Rd +++ b/man/bpmnVisualization-package.Rd @@ -1,39 +1,28 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/bpmnVisualization-package.R +\docType{package} \name{bpmnVisualization-package} -\alias{bpmnVisualization-package} \alias{bpmnVisualization} -\docType{package} -\title{ -\packageTitle{bpmnVisualization} -} +\alias{bpmnVisualization-package} +\title{bpmnVisualization: Visualize Process Execution Data on BPMN Diagrams} \description{ -\packageDescription{bpmnVisualization} -} -\details{ - -The DESCRIPTION file: -\packageDESCRIPTION{bpmnVisualization} -\packageIndices{bpmnVisualization} +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. } -\author{ -\packageAuthor{bpmnVisualization} - -Maintainer: \packageMaintainer{bpmnVisualization} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/process-analytics/bpmn-visualization-R} + \item Report bugs at \url{https://github.com/process-analytics/bpmn-visualization-R/issues} } -\examples{ -\donttest{ -# Load the BPMN file -bpmn_file <- system.file("examples/Order_Management.bpmn", package = "bpmnVisualization") - -# Display the BPMN diagram -display(bpmn_file, width='auto', height='auto') -} } +\author{ +\strong{Maintainer}: Celine Souchet \email{process.analytics.dev+CRAN@gmail.com} -\section{More examples}{ - See \url{https://github.com/process-analytics/bpmn-visualization-R#readme} for more usage examples. +Authors: +\itemize{ + \item Thomas Bouffard } -\section{Support}{ - Use \url{https://github.com/process-analytics/bpmn-visualization-R/issues} for bug reports } +\keyword{internal}