From ff8429faa135ed0ab308f4e696e94971bff2c0de Mon Sep 17 00:00:00 2001 From: Celine Souchet Date: Wed, 25 Aug 2021 14:50:06 +0200 Subject: [PATCH 1/5] Init project --- DESCRIPTION | 9 ++++++ NAMESPACE | 1 + README.md | 45 +++++++++++++++++++++++++---- man/bpmn-visualization-r-package.Rd | 36 +++++++++++++++++++++++ 4 files changed, 85 insertions(+), 6 deletions(-) create mode 100644 DESCRIPTION create mode 100644 NAMESPACE create mode 100644 man/bpmn-visualization-r-package.Rd diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..5527f95 --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,9 @@ +Package: bpmnVisualizationR +Type: Package +Title: BPMN Visualization - R package +Version: 1.0 +Date: 2021-08-25 +Author: process-analytics +Maintainer: csouchet, tbouffard +Description: A R package which embeds BPMN Visualization +License: Apache-2.0 diff --git a/NAMESPACE b/NAMESPACE new file mode 100644 index 0000000..07e9e26 --- /dev/null +++ b/NAMESPACE @@ -0,0 +1 @@ +export("JB.fake.fun") diff --git a/README.md b/README.md index f84dc53..fd735f8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

BPMN Visualization - R Package

- - GitHub release (latest by date including pre-releases) + + GitHub release (latest by date including pre-releases) - - Build + + Build
@@ -15,10 +15,43 @@ Contributor Covenant - License + License


-A R package which embeds BPMN Visualization +This project is an R interface to the [BPMN Visualization](https://github.com/process-analytics/bpmn-visualization-js) library. + +## ♻️ Usage +### Installation +Install from GitHub: +```r +devtools::install_github("process-analytics/bpmn-visualization-R") +library(bpmn) +``` + +### Initialize the R package +```r +bpmn-visualization() +``` + +## 🔧 Contributing + +To contribute to `bpmn-visualization-R`, fork and clone this repository locally and commit your code on a separate branch. \ +Please write tests for your code before opening a pull-request. + +You can find more detail in our [Contributing guide](CONTRIBUTING.md). Participation in this open source project is subject to a [Code of Conduct](CODE_OF_CONDUCT.md). + +✨ A BIG thanks to all our contributors 🙂 + +## ⚒️ Development +### Installation +```r +devtools::install() +``` + +## 📃 License + +`bpmn-visualization-R` is released under the [Apache 2.0](LICENSE) license. \ +Copyright © from 2021, Bonitasoft S.A. \ No newline at end of file diff --git a/man/bpmn-visualization-r-package.Rd b/man/bpmn-visualization-r-package.Rd new file mode 100644 index 0000000..eb3c965 --- /dev/null +++ b/man/bpmn-visualization-r-package.Rd @@ -0,0 +1,36 @@ +\name{bpmn-visualization-r-package} +\alias{bpmn-visualization-r-package} +\alias{bpmn-visualization-r} +\docType{package} +\title{ +\packageTitle{bpmn-visualization-r} +} +\description{ +\packageDescription{bpmn-visualization-r} +} +\details{ + +The DESCRIPTION file: +\packageDESCRIPTION{bpmn-visualization-r} +\packageIndices{bpmn-visualization-r} +~~ An overview of how to use the package, including the most important ~~ +~~ functions ~~ +} +\author{ +\packageAuthor{bpmn-visualization-r} + +Maintainer: \packageMaintainer{bpmn-visualization-r} +} +\references{ +~~ Literature or other references for background information ~~ +} +~~ Optionally other standard keywords, one per line, from file KEYWORDS in ~~ +~~ the R documentation directory ~~ +\keyword{ package } +\seealso{ +~~ Optional links to other man pages, e.g. ~~ +~~ \code{\link[:-package]{}} ~~ +} +\examples{ +# simple examples of the most important functions +} From 3120af7b5c0dc6e73e3a6f1497df1c163d421714 Mon Sep 17 00:00:00 2001 From: Celine Souchet Date: Wed, 25 Aug 2021 15:45:00 +0200 Subject: [PATCH 2/5] Fix doc and installation --- .gitignore | 1 + DESCRIPTION | 7 ++++--- NAMESPACE | 2 +- R/bpmnVisualization.R | 15 +++++++++++++++ README.md | 2 +- ...package.Rd => bpmnVisualization-package.Rd} | 18 +++++++++--------- 6 files changed, 31 insertions(+), 14 deletions(-) create mode 100644 R/bpmnVisualization.R rename man/{bpmn-visualization-r-package.Rd => bpmnVisualization-package.Rd} (61%) diff --git a/.gitignore b/.gitignore index e4e9444..17dece7 100644 --- a/.gitignore +++ b/.gitignore @@ -38,3 +38,4 @@ vignettes/*.pdf # R Environment Variables .Renviron /.idea/ +*.iml diff --git a/DESCRIPTION b/DESCRIPTION index 5527f95..bae367d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,9 +1,10 @@ -Package: bpmnVisualizationR +Package: bpmnVisualization Type: Package Title: BPMN Visualization - R package Version: 1.0 Date: 2021-08-25 -Author: process-analytics -Maintainer: csouchet, tbouffard +Authors@R: c(person("Céline Souchet", "Developer", role = c("aut", "cre"), email = "celine.souchet@bonitasoft.com"), + person("Thomas Bouffard", "Developer", role = "aut")) Description: A R package which embeds BPMN Visualization License: Apache-2.0 +Copyright: Bonitasoft S.A. diff --git a/NAMESPACE b/NAMESPACE index 07e9e26..2ac8daf 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1 +1 @@ -export("JB.fake.fun") +export(bpmnVisualization) diff --git a/R/bpmnVisualization.R b/R/bpmnVisualization.R new file mode 100644 index 0000000..e3b295b --- /dev/null +++ b/R/bpmnVisualization.R @@ -0,0 +1,15 @@ +## import operator +#' @importFrom data.table ":=" +NULL + +#' @importFrom magrittr "%>%" +NULL + +#### +#' function list gateway : detect and create a list of gateways +#' +#' @return 'hello' +#' +bpmnVisualization <- function() { + returnValue('hello') +} \ No newline at end of file diff --git a/README.md b/README.md index fd735f8..9b6f063 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ library(bpmn) ### Initialize the R package ```r -bpmn-visualization() +bpmnVisualization::bpmnVisualization() ``` ## 🔧 Contributing diff --git a/man/bpmn-visualization-r-package.Rd b/man/bpmnVisualization-package.Rd similarity index 61% rename from man/bpmn-visualization-r-package.Rd rename to man/bpmnVisualization-package.Rd index eb3c965..9e801cc 100644 --- a/man/bpmn-visualization-r-package.Rd +++ b/man/bpmnVisualization-package.Rd @@ -1,25 +1,25 @@ -\name{bpmn-visualization-r-package} -\alias{bpmn-visualization-r-package} -\alias{bpmn-visualization-r} +\name{bpmnVisualization-package} +\alias{bpmnVisualization-package} +\alias{bpmnVisualization} \docType{package} \title{ -\packageTitle{bpmn-visualization-r} +\packageTitle{bpmnVisualization} } \description{ -\packageDescription{bpmn-visualization-r} +\packageDescription{bpmnVisualization} } \details{ The DESCRIPTION file: -\packageDESCRIPTION{bpmn-visualization-r} -\packageIndices{bpmn-visualization-r} +\packageDESCRIPTION{bpmnVisualization} +\packageIndices{bpmnVisualization} ~~ An overview of how to use the package, including the most important ~~ ~~ functions ~~ } \author{ -\packageAuthor{bpmn-visualization-r} +\packageAuthor{bpmnVisualization} -Maintainer: \packageMaintainer{bpmn-visualization-r} +Maintainer: \packageMaintainer{bpmnVisualization} } \references{ ~~ Literature or other references for background information ~~ From 305d98804a8e396ba01aed8bdbad55df93d1dd94 Mon Sep 17 00:00:00 2001 From: Celine Souchet Date: Wed, 25 Aug 2021 15:54:30 +0200 Subject: [PATCH 3/5] Fix README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b6f063..1fbc198 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ This project is an R interface to the [BPMN Visualization](https://github.com/pr Install from GitHub: ```r devtools::install_github("process-analytics/bpmn-visualization-R") -library(bpmn) +library(bpmnVisualization) ``` ### Initialize the R package From 7719897531e651d650f0cd72590e6c753f377a87 Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Thu, 26 Aug 2021 14:47:04 +0200 Subject: [PATCH 4/5] Add RStudio config file to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 17dece7..7deb8a3 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ # RStudio files .Rproj.user/ +*.Rproj # produced vignettes vignettes/*.html From 13afec0f577b8292b9ea63444e800817c8c10e94 Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Thu, 26 Aug 2021 14:49:31 +0200 Subject: [PATCH 5/5] Update function description --- R/bpmnVisualization.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/bpmnVisualization.R b/R/bpmnVisualization.R index e3b295b..f6fbe6d 100644 --- a/R/bpmnVisualization.R +++ b/R/bpmnVisualization.R @@ -6,7 +6,7 @@ NULL NULL #### -#' function list gateway : detect and create a list of gateways +#' function bpmn visualization: entry point #' #' @return 'hello' #'