Skip to content

Commit

Permalink
Cran compatibility changes
Browse files Browse the repository at this point in the history
* Add CRAN specific changes
* Package documentation
* Fix based on cran check
* Add cran comments
  • Loading branch information
gowthamrao authored Sep 9, 2023
1 parent cd46800 commit baa8ceb
Show file tree
Hide file tree
Showing 20 changed files with 71 additions and 30 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ readme.md
^compare_versions
^deploy.sh
^docs
^man-roxygen
^man-roxygen
^cran-comments\.md$
10 changes: 5 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Package: CohortExplorer
Type: Package
Title: An R package with a Shiny viewer to explore profiles of patients in a cohort
Version: 0.0.14
Date: 2022-05-27
Title: An R Package with a Shiny Viewer to Explore Profiles of Patients in a Cohort
Version: 0.0.15
Date: 2023-09-06
Authors@R: c(
person("Gowtham", "Rao", email = "[email protected]", role = c("aut", "cre")),
person("Observational Health Data Science and Informatics", role = c("cph"))
Expand All @@ -22,10 +22,10 @@ Imports:
stats
Suggests:
rmarkdown,
SqlRender,
testthat,
knitr,
withr,
SqlRender
withr
License: Apache License
RoxygenNote: 7.2.3
VignetteBuilder: knitr
Expand Down
7 changes: 6 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
CohortExplorer 0.0.13
CohortExplorer 0.0.15
======================
Destination CRAN


CohortExplorer 0.0.14
======================

Reduces the need to move data into R
Expand Down
17 changes: 17 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
This is new release.

---

## Test environments
* Ubuntu 20.04, R 4.3.1
* Microsoft Windows Server 2016, R 4.2.3
* MacOS, 4.3.1
* Windows 10, R 4.3.1

## R CMD check results

There were no ERRORs or WARNINGs.

## Downstream dependencies

All dependencies are in CRAN.
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/articles/HowToUseCohortExplorer.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pandoc: 2.19.2
pandoc: 3.1.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles:
HowToUseCohortExplorer: HowToUseCohortExplorer.html
last_built: 2023-05-27T11:27Z
last_built: 2023-09-06T10:21Z

2 changes: 1 addition & 1 deletion docs/pull_request_template.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/CohortExplorer-package.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/createCohortExplorerApp.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/exportCohortExplorerAppFiles.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified extras/CohortExplorer.pdf
Binary file not shown.
14 changes: 14 additions & 0 deletions extras/PackageMaintenance.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ styler::style_pkg()
OhdsiRTools::checkUsagePackage("CohortExplorer")
OhdsiRTools::updateCopyrightYearFolder()

# Devtools check -----------------------------------------------------------
devtools::spell_check()
devtools::check()

# Create manual -----------------------------------------------------------
unlink("extras/CohortExplorer.pdf")
shell("R CMD Rd2pdf ./ --output=extras/CohortExplorer.pdf")
dir.create(path = file.path("inst", "doc"), showWarnings = FALSE, recursive = TRUE)

# Create Vignettes---------------------------------------------------------
rmarkdown::render("vignettes/HowToUseCohortExplorer.Rmd",
Expand All @@ -32,5 +37,14 @@ rmarkdown::render("vignettes/HowToUseCohortExplorer.Rmd",


# Build site---------------------------------------------------------
devtools::document()
pkgdown::build_site()
OhdsiRTools::fixHadesLogo()



# Release package to CRAN ------------------------------------------------------
devtools::check_win_devel()
devtools::check_rhub()
devtools::release()
devtools::check(cran=TRUE)
Binary file modified inst/doc/HowToUseCohortExplorer.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion man/CohortExplorer-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit baa8ceb

Please sign in to comment.