fix: update the DESCRIPTION file and the R doc according last submission (#195)

Author: csouchet

DESCRIPTION

@@ -1,10 +1,10 @@
 Package: bpmnVisualizationR
 Type: Package
-Title: Visualize Process Execution Data on BPMN Diagrams
+Title: Visualize Process Execution Data on 'BPMN' Diagrams
 Version: 0.3.1.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 the bpmn-visualization TypeScript library.
+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/

R/bpmnVisualizationR.R

@@ -12,23 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#' @title Display BPMN diagram in an HTML Widget
+#' @title Display 'BPMN' diagram in an 'HTML' Widget
 #'
 #' @name display
-#' @description Display BPMN diagram based on BPMN definition in XML format
+#' @description Display 'BPMN' diagram based on 'BPMN' definition in 'XML' format
 #'
-#' @param bpmnXML A file name or xml document or string in BPMN XML format
+#' @param bpmnXML A file name or 'XML' document or string in 'BPMN' 'XML' format
 #' @param overlays An element or a list of elements to be added to the diagram's existing elements.
 #'      Use overlay function to create an overlay object with content and relative position.
 #' @param width Fixed width for widget (in css units). The default is \code{NULL}, which results in intelligent automatic sizing based on the widget's container.
 #' @param height Fixed height for widget (in css units). The default is \code{NULL}, which results in intelligent automatic sizing based on the widget's container.
-#' @param elementId The id of the HTML element to enclose the widget.
+#' @param elementId The id of the 'HTML' element to enclose the widget.
 #'      Use an explicit element ID for the widget (rather than an automatically
-#'      generated one). Useful if you have other JavaScript that needs to explicitly
+#'      generated one). Useful if you have other 'JavaScript' that needs to explicitly
 #'      discover and interact with a specific widget instance.
 #'
-#' @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.
+#' @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
@@ -73,18 +73,18 @@ display <- function(
   )
 }
 
-#' @title Shiny output binding for the \code{bpmnVisualizationR} HTML widget
+#' @title Shiny output binding for the \code{bpmnVisualizationR} 'HTML' widget
 #'
 #' @name bpmnVisualizationR-shiny-output
 #' @description
-#' Helper to create output function for using the \code{bpmnVisualizationR} 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{bpmnVisualizationR} widget within Shiny applications.
+#' @returns An output function that enables the use of the \code{bpmnVisualizationR} widget within 'Shiny' applications.
 #'
 #' @export
 bpmnVisualizationROutput <- function(
@@ -101,18 +101,18 @@ bpmnVisualizationROutput <- function(
   )
 }
 
-#' @title Shiny render binding for the \code{bpmnVisualizationR} HTML widget
+#' @title 'Shiny' render binding for the \code{bpmnVisualizationR} 'HTML' widget
 #'
 #' @rdname bpmnVisualizationR-shiny-render
 #' @description
-#' Helper to create render function for using the \code{bpmnVisualizationR} 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{bpmnVisualizationR} 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{bpmnVisualizationR} widget within Shiny applications.
+#' @returns A render function that enables the use of the \code{bpmnVisualizationR} widget within 'Shiny' applications.
 #'
 #' @export
 renderBpmnVisualizationR <- function(

R/funs.R

@@ -9,7 +9,7 @@
 #' Use this structure to create correct overlay structure.
 #' 
 #' @param elementId The bpmn element id to which the overlay will be attached
-#' @param label HTML element to use as an overlay
+#' @param label 'HTML' element to use as an overlay
 #'
 #' @returns An overlay object
 #'
@@ -22,7 +22,7 @@ create_overlay <- function(elementId, label) {
     )
 }
 
-#' @description Internal fun to build the htmlwidget content
+#' @description Internal fun to build the 'htmlwidget' content
 #'
 #' @inheritParams display
 #' @returns A list

cran-comments.md

@@ -1,3 +1,66 @@
+# bpmnVisualizationR 0.3.1.9000
+
+This is a new submission. In this version, we have:
+
+* Added single quotes for package names, software names and API, in `title` and `description` on the [DESCRIPTION](DESCRIPTION) file.
+* Added single quotes for package names, software names and API, in the documentation of the methods of this package.
+
+## Test environments
+
+- R-hub windows-x86_64-devel (r-devel). Platform: Windows Server 2022, R-devel, 64 bit
+- R-hub ubuntu-gcc-release (r-release). Platform: Ubuntu Linux 20.04.1 LTS, R-release, GCC
+- R-hub fedora-clang-devel (r-devel). Platform: Fedora Linux, R-devel, clang, gfortran
+
+## R CMD check results
+
+There were no ERRORs or WARNINGs.
+
+As noted in [R-hub issue #503](https://github.com/r-hub/rhub/issues/503), this could be due to a bug/crash in MiKTeX and can likely be ignored.
+Also, we cannot change that `Tidy` is not on the path or update `Tidy` on the external Fedora Linux server.
+
+❯ On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release)
+  checking CRAN incoming feasibility ... NOTE
+  Maintainer: 'Celine Souchet <process.analytics.dev+CRAN@gmail.com>'
+  
+  New submission
+  
+❯ On windows-x86_64-devel (r-devel)
+  checking for detritus in the temp directory ... NOTE
+  Found the following files/directories:
+    'lastMiKTeXException'
+
+❯ On fedora-clang-devel (r-devel)
+  checking CRAN incoming feasibility ... [6s/25s] NOTE
+  Maintainer: ‘Celine Souchet <process.analytics.dev+CRAN@gmail.com>’
+  
+  New submission
+  
+❯ On fedora-clang-devel (r-devel)
+  checking HTML version of manual ... NOTE
+  Skipping checking HTML validation: no command 'tidy' found
+
+0 errors ✔ | 0 warnings ✔ | 4 notes ✖
+
+## Response to CRAN for last submission
+
+> If there are references describing the methods in your package, please
+> add these in the description field of your DESCRIPTION file in the form
+> authors (year) <doi:...>
+> authors (year) <arXiv:...>
+> authors (year, ISBN:...)
+> or if those are not available: <https:...>
+> with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
+> auto-linking. (If you want to add a title as well please put it in quotes: "Title")
+
+There is no reference describing the methods in this package.
+
+> Please always write package names, software names and API (application
+> programming interface) names in single quotes in title and description.
+> e.g: --> 'TypeScript'
+> Please note that package names are case-sensitive.
+
+✅ Done on the [DESCRIPTION](DESCRIPTION) file and the documentation of the methods of this package.
+
 # bpmnVisualizationR 0.3.1
 
 This is a new submission. In this version, we have: