diff --git a/.gitignore b/.gitignore index e4e9444..7deb8a3 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ # RStudio files .Rproj.user/ +*.Rproj # produced vignettes vignettes/*.html @@ -38,3 +39,4 @@ vignettes/*.pdf # R Environment Variables .Renviron /.idea/ +*.iml diff --git a/DESCRIPTION b/DESCRIPTION new file mode 100644 index 0000000..bae367d --- /dev/null +++ b/DESCRIPTION @@ -0,0 +1,10 @@ +Package: bpmnVisualization +Type: Package +Title: BPMN Visualization - R package +Version: 1.0 +Date: 2021-08-25 +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 new file mode 100644 index 0000000..2ac8daf --- /dev/null +++ b/NAMESPACE @@ -0,0 +1 @@ +export(bpmnVisualization) diff --git a/R/bpmnVisualization.R b/R/bpmnVisualization.R new file mode 100644 index 0000000..f6fbe6d --- /dev/null +++ b/R/bpmnVisualization.R @@ -0,0 +1,15 @@ +## import operator +#' @importFrom data.table ":=" +NULL + +#' @importFrom magrittr "%>%" +NULL + +#### +#' function bpmn visualization: entry point +#' +#' @return 'hello' +#' +bpmnVisualization <- function() { + returnValue('hello') +} \ No newline at end of file diff --git a/README.md b/README.md index f84dc53..1fbc198 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(bpmnVisualization) +``` + +### Initialize the R package +```r +bpmnVisualization::bpmnVisualization() +``` + +## 🔧 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/bpmnVisualization-package.Rd b/man/bpmnVisualization-package.Rd new file mode 100644 index 0000000..9e801cc --- /dev/null +++ b/man/bpmnVisualization-package.Rd @@ -0,0 +1,36 @@ +\name{bpmnVisualization-package} +\alias{bpmnVisualization-package} +\alias{bpmnVisualization} +\docType{package} +\title{ +\packageTitle{bpmnVisualization} +} +\description{ +\packageDescription{bpmnVisualization} +} +\details{ + +The DESCRIPTION file: +\packageDESCRIPTION{bpmnVisualization} +\packageIndices{bpmnVisualization} +~~ An overview of how to use the package, including the most important ~~ +~~ functions ~~ +} +\author{ +\packageAuthor{bpmnVisualization} + +Maintainer: \packageMaintainer{bpmnVisualization} +} +\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 +}