Skip to content

Commit

Permalink
[INFRA] Clean warnings to facilitate CRAN submission (#49)
Browse files Browse the repository at this point in the history
Clean the package Rmd file
The GitHub worklow runs more R version (release and devel)
  • Loading branch information
tbouffard authored Sep 13, 2021
1 parent 6dcc48d commit 9f298b4
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 11 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ jobs:
config:
- {os: ubuntu-20.04, r: '3.6.3'}
- {os: ubuntu-20.04, r: '4.1.1'}
# CRAN submission required to use this R version
- {os: ubuntu-20.04, r: 'release'}
# To catch errors with upcoming R version
- {os: ubuntu-20.04, r: 'devel'}

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
Expand Down
2 changes: 2 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ License: Apache License (== 2)
Copyright: Bonitasoft S.A.
URL: 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.1.1
Imports:
htmlwidgets,
Expand Down
27 changes: 16 additions & 11 deletions man/bpmnVisualization-package.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,29 @@
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 ~~
\examples{
\dontrun{

bpmnVisualization::display(bpmn_xml)

}
\keyword{
~~ Optionally other standard keywords, one per line, from file KEYWORDS in ~~
~~ the R documentation directory ~~

}
\seealso{
~~ Optional links to other man pages ~~

\section{More examples}{


See \url{https://github.com/process-analytics/bpmn-visualization-R#readme} for more usage examples.
}
\examples{
# simple examples of the most important functions

\section{Support}{


Use \url{https://github.com/process-analytics/bpmn-visualization-R/issues} for bug reports
}

0 comments on commit 9f298b4

Please sign in to comment.