Skip to content

Commit

Permalink
Added alternative signposting to package vignettets in README. Comple…
Browse files Browse the repository at this point in the history
…ted cran comments.
  • Loading branch information
PHEgeorginaanderson committed Apr 12, 2020
1 parent 83398cc commit a248de0
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 13 deletions.
7 changes: 3 additions & 4 deletions README.Rmd
Expand Up @@ -85,14 +85,13 @@ The package contains the following functions, datasets and vignettes - see indiv

- phe_dsr
- phe_isr
- phe_life_expectancy
- phe_mean
- phe_proportion
- phe_quantile
- phe_rate
- phe_smr
- phe_quantile
- phe_life_expectancy
- phe_sii
- phe_smr


**Datasets:**
Expand All @@ -108,6 +107,6 @@ The package contains the following functions, datasets and vignettes - see indiv
- Vignette for calculating DSRs for multiple geographies and time periods
- Vignette showing worked examples of the phe_sii function

(type 'browseVignettes("PHEindicatormethods")' to view in HTML)
(type 'browseVignettes("PHEindicatormethods")' to view in HTML or access vignettes from the package's CRAN webpage [here](https://CRAN.R-project.org/package=PHEindicatormethods))


9 changes: 5 additions & 4 deletions README.md
Expand Up @@ -81,14 +81,13 @@ see individual item documentation for full details

- phe\_dsr
- phe\_isr
- phe\_life\_expectancy
- phe\_mean
- phe\_proportion
- phe\_quantile
- phe\_rate
- phe\_smr
- phe\_quantile
- phe\_life\_expectancy
- phe\_sii
- phe\_smr

**Datasets:**

Expand All @@ -105,4 +104,6 @@ see individual item documentation for full details
periods
- Vignette showing worked examples of the phe\_sii function

(type ‘browseVignettes(“PHEindicatormethods”)’ to view in HTML)
(type ‘browseVignettes(“PHEindicatormethods”)’ to view in HTML or access
vignettes from the package’s CRAN webpage
[here](https://CRAN.R-project.org/package=PHEindicatormethods))
20 changes: 15 additions & 5 deletions cran-comments.md
@@ -1,19 +1,29 @@
## Submission of package version 1.3.1
Five functions within the package have been amended to ensure continued compatability with dplyr v1.0.0 due for release 1st May 2020.

Additionally, the phe_life_expectancy function has been amended to show more relevant population and death counts in the output.
Additionally, the phe_life_expectancy function has been amended (bug fix) to show more relevant population and death counts in the output.

## R CMD check results
There were no ERRORs, WARNINGS or NOTES on local Windows 10 install using R 3.6.3 and RStudio 1.2.5019

## Test Environments
* local windows 10 installs: R3.6.3 - OK
local windows 10 installs: R3.6.3 - OK

* Travis check on Linux (2020-04-11) - passed
Travis check on Linux (2020-04-11) - OK

* devtools::check_win gave no ERRORS, WARNINGS or NOTES on the following versions: R version 3.5.3 (2019-03-11), R version 3.6.3 (2020-02-29) and R Under development (unstable) (2020-01-28 r77738).
devtools::check_win gave no ERRORS, WARNINGS or NOTES on the following versions:
* R version 4.0.0 alpha (2020-03-26 r78078)
* R version 3.6.3 (2020-02-29)
* R version 3.5.3 (2019-03-11)

* devtools::check_rhub has been run on the following platforms: Fedora Linux, R-devel, clang, gfortran; Windows Server 2008 R2 SP1, R-devel, 32/64 bit; Ubuntu Linux 16.04 LTS, R-release, GCC. These build checks produced a couple of NOTES about possible mispellings, possible invalid DOIs which are all valid and not critical to the functioning of the package.
* devtools::check_rhub has been run on the following platforms. These build checks produced a couple of NOTES about possible mispellings, possible invalid DOIs which are all valid and not critical to the functioning of the package:
* Fedora Linux, R-devel, clang, gfortran
* Windows Server 2008 R2 SP1, R-devel, 32/64 bit
* Ubuntu Linux 16.04 LTS, R-release, GCC


## CRAN Checks for current package release version v1.3.0
There is currently a WARNING against r-patched-osx-x86_64 which relates to an issue loading the package vignette. I am unable to resolve this without access to this OS. The vignettes seem to work Ok elsewhere and are not essential to the package functionality. I have added a comment to the README file offering alternative signposting to package vignettes on CRAN package webpage.

## Downstream dependencies
There are no known downstream dependencies on CRAN

0 comments on commit a248de0

Please sign in to comment.