From 66547ea21a598613ca22a65702d762d502be0361 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 21 Feb 2023 14:50:06 +0100 Subject: [PATCH 1/2] - add badge in the README and index.md for CRAN publication - update comments --- README.md | 11 +++++++---- index.md | 1 + 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 21989dc..6ce157d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ GitHub release (latest by date including pre-releases) + + CRAN release (latest by date) + Build @@ -22,11 +25,11 @@
- + `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. - + ## ♻️ Usage ### Installation @@ -37,7 +40,7 @@ It can be installed from the R console: install.packages('devtools') ``` - + #### 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: @@ -54,7 +57,7 @@ Then, make the library available to the current R project: ```r library(bpmnVisualizationR) ``` - + ### Load the BPMN file `bpmnVisualizationR` accepts a BPMN file (or an XML document): diff --git a/index.md b/index.md index 5fa0219..3ac7e41 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,7 @@ # bpmnVisualizationR +[![CRAN status](https://www.r-pkg.org/badges/version/bpmnVisualizationR)](https://cran.r-project.org/package=bpmnVisualizationR) [![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) From a9df3b9ba93d9e12d032cc927cd613b59b9ddf2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 21 Feb 2023 15:07:29 +0100 Subject: [PATCH 2/2] Update how to install from CRAN in the README.md and index.md --- README.md | 10 +++++++++- index.md | 8 ++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ce157d..b4af410 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,15 @@ install.packages('devtools') ``` -#### Install _bpmnVisualizationR_ from GitHub +#### Install _bpmnVisualizationR_ + +##### From CRAN +The latest stable version of the `bpmnVisualizationR` package can be obtained from [CRAN](https://cran.r-project.org/web/packages/bpmnVisualizationR/index.html) with the command: +``` +install.packages("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 diff --git a/index.md b/index.md index 3ac7e41..704f6ae 100644 --- a/index.md +++ b/index.md @@ -18,6 +18,14 @@ It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provide ## Installation +### From CRAN +The latest stable version of the `bpmnVisualizationR` package can be obtained from [CRAN](https://cran.r-project.org/web/packages/bpmnVisualizationR/index.html) with the command: +``` +install.packages("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 devtools::install_github("process-analytics/bpmn-visualization-R@v0.3.2")