[FEAT] Initialize the project (#21)

Author: csouchet

.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

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.

NAMESPACE

@@ -0,0 +1 @@
+export(bpmnVisualization)

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')
+}

README.md

@@ -1,11 +1,11 @@
 <h1 align="center">BPMN Visualization - R Package</h1>
 <div align="center">
     <p align="center">
-        <a href="/process-analytics/bpmn-visualization-r/releases">
-          <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/process-analytics/bpmn-visualization-r?label=changelog&include_prereleases"> 
+        <a href="/process-analytics/bpmn-visualization-R/releases">
+          <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/process-analytics/bpmn-visualization-R?label=changelog&include_prereleases"> 
         </a>
-        <a href="/process-analytics/bpmn-visualization-r/actions">
-          <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-r/workflows/Build/badge.svg"> 
+        <a href="/process-analytics/bpmn-visualization-R/actions">
+          <img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-R/workflows/Build/badge.svg"> 
         </a>
         <br>
         <a href="CONTRIBUTING.md">
@@ -15,10 +15,43 @@
           <img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg"> 
         </a> 
         <a href="LICENSE">
-          <img alt="License" src="https://img.shields.io/github/license/process-analytics/bpmn-visualization-r?color=blue"> 
+          <img alt="License" src="https://img.shields.io/github/license/process-analytics/bpmn-visualization-R?color=blue"> 
         </a>
     </p>
 </div>  
 <br>
 
-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 &copy; from 2021, Bonitasoft S.A.

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[<pkg>:<pkg>-package]{<pkg>}} ~~
+}
+\examples{
+# simple examples of the most important functions
+}