Skip to content

Commit 9f298b4

Browse files
authored
[INFRA] Clean warnings to facilitate CRAN submission (#49)
Clean the package Rmd file The GitHub worklow runs more R version (release and devel)
1 parent 6dcc48d commit 9f298b4

File tree

3 files changed

+22
-11
lines changed

3 files changed

+22
-11
lines changed

.github/workflows/R-CMD-check.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ jobs:
2222
config:
2323
- {os: ubuntu-20.04, r: '3.6.3'}
2424
- {os: ubuntu-20.04, r: '4.1.1'}
25+
# CRAN submission required to use this R version
26+
- {os: ubuntu-20.04, r: 'release'}
27+
# To catch errors with upcoming R version
28+
- {os: ubuntu-20.04, r: 'devel'}
2529

2630
env:
2731
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true

DESCRIPTION

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ License: Apache License (== 2)
99
Copyright: Bonitasoft S.A.
1010
URL: https://github.com/process-analytics/bpmn-visualization-R
1111
BugReports: https://github.com/process-analytics/bpmn-visualization-R/issues
12+
Encoding: UTF-8
13+
LazyData: true
1214
RoxygenNote: 7.1.1
1315
Imports:
1416
htmlwidgets,

man/bpmnVisualization-package.Rd

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,29 @@
1313
The DESCRIPTION file:
1414
\packageDESCRIPTION{bpmnVisualization}
1515
\packageIndices{bpmnVisualization}
16-
~~ An overview of how to use the package, including the most important ~~
17-
~~ functions ~~
1816
}
1917
\author{
2018
\packageAuthor{bpmnVisualization}
2119

2220
Maintainer: \packageMaintainer{bpmnVisualization}
2321
}
24-
\references{
25-
~~ Literature or other references for background information ~~
22+
\examples{
23+
\dontrun{
24+
25+
bpmnVisualization::display(bpmn_xml)
26+
2627
}
27-
\keyword{
28-
~~ Optionally other standard keywords, one per line, from file KEYWORDS in ~~
29-
~~ the R documentation directory ~~
28+
3029
}
31-
\seealso{
32-
~~ Optional links to other man pages ~~
30+
31+
\section{More examples}{
32+
33+
34+
See \url{https://github.com/process-analytics/bpmn-visualization-R#readme} for more usage examples.
3335
}
34-
\examples{
35-
# simple examples of the most important functions
36+
37+
\section{Support}{
38+
39+
40+
Use \url{https://github.com/process-analytics/bpmn-visualization-R/issues} for bug reports
3641
}

0 commit comments

Comments
 (0)