Rename the package as bpmnVisualizationR

Author: csouchet

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-You are here to help on `bpmn-visualization-R`? Awesome, feel welcome and read the following guidelines in order to know how to contribute, to ask questions and to make `bpmn-visualization-R` such a great tool.
+You are here to help on `bpmnVisualizationR`? Awesome, feel welcome and read the following guidelines in order to know how to contribute, to ask questions and to make `bpmnVisualizationR` such a great tool.
 
 All members of our community are expected to follow our [Code of Conduct](https://github.com/process-analytics/.github/blob/main/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
 
@@ -11,7 +11,7 @@ There are many ways to contribute:
 - help people with the questions they ask on the [GitHub Issues](https://github.com/process-analytics/bpmn-visualization-R/issues)
 - submitting bug reports and feature requests in the [GitHub Issues](https://github.com/process-analytics/bpmn-visualization-R/issues/new)
 - improving the README & documentation
-- writing code which can be incorporated into `bpmn-visualization-R` itself
+- writing code which can be incorporated into `bpmnVisualizationR` itself
 
 ### Code and documentation changes guidelines
 
@@ -34,7 +34,7 @@ For all contributions, please respect the following guidelines:
 
 ### Fork & create a branch
 
-[Fork bpmn-visualization-R](https://help.github.com/articles/fork-a-repo) and create a branch with a descriptive name. 
+[Fork the bpmn-visualization-R repository](https://help.github.com/articles/fork-a-repo) and create a branch with a descriptive name. 
 
 A good branch name would be (where issue #25 is the ticket you're working on): **25-customize_overlays**
 
@@ -51,8 +51,7 @@ The most important part is the title of the Pull Request, because:
 
 ### Open a Pull Request
 
-At this point, you should switch back to your main branch and make sure it's up-to-date with `bpmn-visualization-R`
-`main` branch:
+At this point, you should switch back to your main branch and make sure it's up-to-date with the `main` branch of the `bpmn-visualization-R` repository:
 
 ```sh
 git remote add upstream git@github.com:process-analytics/bpmn-visualization-R.git
@@ -88,7 +87,7 @@ You only need to sign the CLA once or when the CLA terms have changed.
 
 ### Keeping your Pull Request updated
 
-If a maintainer asks you to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
+If a maintainer asks you to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your PR, they're saying that a lot of code has changed, and that you need to update your branch, so it's easier to merge.
 
 Here's the suggested workflow:
 

DESCRIPTION

@@ -1,17 +1,17 @@
-Package: bpmnVisualization
+Package: bpmnVisualizationR
 Type: Package
 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 (Business Process Model and Notation) 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 the bpmn-visualization TypeScript library.
 License: Apache License (== 2)
 Copyright: Bonitasoft S.A.
-URL: https://process-analytics.github.io/bpmn-visualization-R/, https://github.com/process-analytics/bpmn-visualization-R
+URL: https://process-analytics.github.io/bpmn-visualization-R, https://github.com/process-analytics/bpmn-visualization-R
 BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Imports:
     htmlwidgets,
     rlang,

MAINTAINERS.md

@@ -125,7 +125,7 @@ It conforms to [the CRAN Submission policies first](https://cran.r-project.org/w
 
 You can use this template:
 
-> 📣 bpmn-visualization R package {version} is out! 🎉
+> 📣 bpmnVisualizationR {version} is out! 🎉
 >
 > ===> some short description here <===
 >
@@ -139,7 +139,7 @@ Channel: [news](https://discord.com/channels/1011911769607913562/102432915903349
 
 You can use this template:
 
-> 📣 bpmn-visualization R package {version} is out! 🎉
+> 📣 bpmnVisualizationR {version} is out! 🎉
 >
 > ===> some short description here <===
 >

NAMESPACE

@@ -1,8 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
-export(bpmnVisualizationOutput)
+export(bpmnVisualizationROutput)
 export(create_overlay)
 export(display)
-export(renderBpmnVisualization)
+export(renderBpmnVisualizationR)
 import(htmlwidgets)
 import(xml2)

R/bpmnVisualization-package.R R/bpmnVisualizationR-package.RR/bpmnVisualization-package.R renamed to R/bpmnVisualizationR-package.R

@@ -27,23 +27,23 @@
 #'      generated one). Useful if you have other JavaScript that needs to explicitly
 #'      discover and interact with a specific widget instance.
 #'
-#' @returns A \code{bpmn-visualization} Widget that will intelligently print itself into HTML in a variety of contexts
+#' @returns A \code{bpmnVisualizationR} Widget that will intelligently print itself into HTML in a variety of contexts
 #'      including the R console, within R Markdown documents, and within Shiny output bindings.
 #'
 #' @examples
 #' # Load the BPMN file
-#' bpmn_file <- system.file("examples/Order_Management.bpmn", package = "bpmnVisualization")
+#' bpmn_file <- system.file("examples/Order_Management.bpmn", package = "bpmnVisualizationR")
 #'
 #' # Display the BPMN diagram
-#' bpmnVisualization::display(bpmn_file, width='auto', height='auto')
+#' bpmnVisualizationR::display(bpmn_file, width='auto', height='auto')
 #'
 #' # Display the BPMN diagram with overlays
 #' overlays <- list(
-#'   create_overlay("start_event_1_1", "42"),
-#'   create_overlay("sequence_flow_1_1", "42"),
-#'   create_overlay("task_1_1", "9")
+#'   bpmnVisualizationR::create_overlay("start_event_1_1", "42"),
+#'   bpmnVisualizationR::create_overlay("sequence_flow_1_1", "42"),
+#'   bpmnVisualizationR::create_overlay("task_1_1", "9")
 #' )
-#' bpmnVisualization::display(bpmn_file, overlays, width='auto', height='auto')
+#' bpmnVisualizationR::display(bpmn_file, overlays, width='auto', height='auto')
 #'
 #' @seealso \code{\link{create_overlay}} to create an overlay
 #'
@@ -64,58 +64,58 @@ display <- function(
   )
   # create widget
   htmlwidgets::createWidget(
-    name = "bpmnVisualization",
+    name = "bpmnVisualizationR",
     x,
     width = width,
     height = height,
-    package = "bpmnVisualization",
+    package = "bpmnVisualizationR",
     elementId = elementId
   )
 }
 
-#' @title Shiny output binding for the \code{bpmn-visualization} HTML widget
+#' @title Shiny output binding for the \code{bpmnVisualizationR} HTML widget
 #'
-#' @name bpmnVisualization-shiny-output
+#' @name bpmnVisualizationR-shiny-output
 #' @description
-#' Helper to create output function for using the \code{bpmn-visualization} HTML widget within Shiny applications and interactive Rmd documents.
+#' Helper to create output function for using the \code{bpmnVisualizationR} HTML widget within Shiny applications and interactive Rmd documents.
 #'
 #' @param outputId output variable to read from
 #' @param width,height Must be a valid CSS unit (like \code{'100\%'},
 #'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
 #'   string and have \code{'px'} appended.
 #'
-#' @returns An output function that enables the use of the \code{bpmn-visualization} widget within Shiny applications.
+#' @returns An output function that enables the use of the \code{bpmnVisualizationR} widget within Shiny applications.
 #'
 #' @export
-bpmnVisualizationOutput <- function(
+bpmnVisualizationROutput <- function(
   outputId,
   width = "100%",
   height = "400px"
 ) {
   htmlwidgets::shinyWidgetOutput(
     outputId,
-    "bpmnVisualization",
+    "bpmnVisualizationR",
     width,
     height,
-    package = "bpmnVisualization"
+    package = "bpmnVisualizationR"
   )
 }
 
-#' @title Shiny render binding for the \code{bpmn-visualization} HTML widget
+#' @title Shiny render binding for the \code{bpmnVisualizationR} HTML widget
 #'
-#' @rdname bpmnVisualization-shiny-render
+#' @rdname bpmnVisualizationR-shiny-render
 #' @description
-#' Helper to create render function for using the \code{bpmn-visualization} HTML widget within Shiny applications and interactive Rmd documents.
+#' Helper to create render function for using the \code{bpmnVisualizationR} HTML widget within Shiny applications and interactive Rmd documents.
 #'
-#' @param expr An expression that generates a \code{bpmn-visualization} HTML widget
+#' @param expr An expression that generates a \code{bpmnVisualizationR} HTML widget
 #' @param env The environment in which to evaluate \code{expr}.
 #' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
 #'   is useful if you want to save an expression in a variable.
 #'
-#' @returns A render function that enables the use of the \code{bpmn-visualization} widget within Shiny applications.
+#' @returns A render function that enables the use of the \code{bpmnVisualizationR} widget within Shiny applications.
 #'
 #' @export
-renderBpmnVisualization <- function(
+renderBpmnVisualizationR <- function(
   expr,
   env = parent.frame(),
   quoted = FALSE
@@ -127,7 +127,7 @@ renderBpmnVisualization <- function(
   } # force quoted
   htmlwidgets::shinyRenderWidget(
     expr,
-    bpmnVisualizationOutput,
+    bpmnVisualizationROutput,
     env,
     quoted = TRUE
   )

R/bpmnVisualization.R R/bpmnVisualizationR.RR/bpmnVisualization.R renamed to R/bpmnVisualizationR.R

@@ -1,4 +1,4 @@
-<h1 align="center">BPMN Visualization - R Package</h1>
+<h1 align="center">bpmnVisualizationR</h1>
 <div align="center">
     <p align="center"> <img title="Email Voting BPMN Diagram with overlays" src="doc/example_email_voting_with_overlays.svg" alt="Email Voting BPMN Diagram with overlays"></p>
     <p align="center">
@@ -23,7 +23,7 @@
 <br>
 
 <!-- duplicated with README.md -->
-`bpmnVisualization` is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.
+`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](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 -->
@@ -38,7 +38,7 @@ install.packages('devtools')
 ```
 
 <!-- duplicated with README.md -->
-#### Install _BPMN Visualization - R Package_ from GitHub
+#### Install _bpmnVisualizationR_ 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:
 ```r
@@ -52,16 +52,16 @@ devtools::install_github("process-analytics/bpmn-visualization-R")
 
 Then, make the library available to the current R project:
 ```r
-library(bpmnVisualization)
+library(bpmnVisualizationR)
 ```
 <!-- END OF duplicated with README.md -->
 
 ### Load the BPMN file
-`bpmnVisualization` accepts a BPMN file (or an XML document):
+`bpmnVisualizationR` accepts a BPMN file (or an XML document):
 
 ```r
 # File from the package
-bpmn_file <- system.file("examples/Email_Voting.bpmn", package = "bpmnVisualization")
+bpmn_file <- system.file("examples/Email_Voting.bpmn", package = "bpmnVisualizationR")
 ```
 
 Or
@@ -89,16 +89,16 @@ They are taken from the [BPMN 2.0 examples non-normative machine readable files]
 
 ### Display the BPMN diagram
 ```r
-bpmnVisualization::display(bpmn_file)
+bpmnVisualizationR::display(bpmn_file)
 ```
 
 
 ### Display the BPMN diagram with overlays
 
 ```r
-overlays <- list(bpmnVisualization::create_overlay("bpmn_element_id_1", "42"), 
-                 bpmnVisualization::create_overlay("bpmn_element_id_2", "9"))
-bpmnVisualization::display(bpmn_file, overlays)
+overlays <- list(bpmnVisualizationR::create_overlay("bpmn_element_id_1", "42"), 
+                 bpmnVisualizationR::create_overlay("bpmn_element_id_2", "9"))
+bpmnVisualizationR::display(bpmn_file, overlays)
 ```
 
 
@@ -113,28 +113,28 @@ library(shiny)
 
 
 displayBpmn <- function() {
-    bpmn_file <- system.file("examples/Travel_Booking.bpmn", package = "bpmnVisualization")
-    overlays <- list(bpmnVisualization::create_overlay("_6-203", "9"))
-    bpmnVisualization::display(bpmn_file, overlays)
+    bpmn_file <- system.file("examples/Travel_Booking.bpmn", package = "bpmnVisualizationR")
+    overlays <- list(bpmnVisualizationR::create_overlay("_6-203", "9"))
+    bpmnVisualizationR::display(bpmn_file, overlays)
 }
 
 ui <- shinyUI(fluidPage(
     titlePanel("Display bpmn diagrams with execution data"),
-    bpmnVisualization::bpmnVisualizationOutput('bpmnContainer')
+    bpmnVisualizationR::bpmnVisualizationROutput('bpmnContainer')
   )
 )
 
 server = function(input, output) {
     # renderBpmnVisualization is the R bridge function to the html widgets
-    output$bpmnContainer <- bpmnVisualization::renderBpmnVisualization({ displayBpmn() })
+    output$bpmnContainer <- bpmnVisualizationR::renderBpmnVisualizationR({ displayBpmn() })
 }
 
 shinyApp(ui, server)
 ```
 
 ## 🔧 Contributing
 
-To contribute to `bpmn-visualization-R`, fork and clone this repository locally and commit your code on a separate branch. \
+To contribute to `bpmnVisualizationR`, 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).
@@ -143,5 +143,5 @@ You can find more detail in our [Contributing guide](CONTRIBUTING.md). Participa
 
 ## 📃 License
 
-`bpmn-visualization-R` is released under the [Apache 2.0](LICENSE) license. \
+`bpmnVisualizationR` is released under the [Apache 2.0](LICENSE) license. \
 Copyright &copy; from 2021, Bonitasoft S.A.

README.md

@@ -1,14 +1,14 @@
 <!-- This page is processed by pkgdown to create the home page of the HTML documentation -->
 
-# BPMN Visualization - R Package
+# bpmnVisualizationR
 
 <!-- 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.
+`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](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 -->
@@ -29,7 +29,7 @@ devtools::install_github("process-analytics/bpmn-visualization-R")
 
 Then, make the library available to the current R project:
 ```r
-library(bpmnVisualization)
+library(bpmnVisualizationR)
 ```
 <!-- END OF duplicated with README.md -->
 
@@ -40,7 +40,7 @@ You first need to retrieve the content of the BPMN diagram. Once you are done, y
 that will render it.
 
 ```r
-bpmnVisualization::display(bpmn_content)
+bpmnVisualizationR::display(bpmn_content)
 ```
 
 Read `?display` for more details.

index.md

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 HTMLWidgets.widget({
-    name: "bpmnVisualization",
+    name: "bpmnVisualizationR",
     type: "output",
 
     factory: function(containerElt, width, height) {