Skip to content

Commit

Permalink
V1.1.1 updated ReadMe, News and cran-comments ready for submission.
Browse files Browse the repository at this point in the history
  • Loading branch information
PHEgeorginaanderson committed Apr 17, 2019
1 parent 7610a08 commit 6e9ef4d
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 30 deletions.
Binary file modified .RData
Binary file not shown.
6 changes: 0 additions & 6 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
## PHEindicatormethods v1.1.1

Minor changes to phe_sii function documentation



## PHEindicatormethods v1.1.0

The following changes may affect backwards compatibility with earlier versions of the package:

* phe_proportion: Replaced logical PERCENTAGE argument with a numeric MULTIPLIER argument to enable proportions to be expressed more flexibly (eg per 1000). Default is now multiplier = 1 which gives equivalent output to the previous default of percentage = FALSE. There is loss of backwards compatibility where the percentage argument has previously been specified in the function call - please replace 'percentage=TRUE' with 'multiplier=100' and 'percentage=FALSE' with 'multiplier=1'.
Expand Down
4 changes: 3 additions & 1 deletion R/SII_function.R
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#' according to the indicator polarity. Since the relative ranks, by definition, range from
#' 0 to 1, the SII is the difference between the fitted value at \code{x=1} and \code{x=0}.
#'
#' The RII is the ration of the fitted value at \code{x=1,Y1} and the fitted value at
#' The RII is the ratio of the fitted value at \code{x=1,Y1} and the fitted value at
#' \code{x=0,Y0}. which can be calculated as: \code{RII = (Y0 + SII)/Y0}
#'
#' @section Function arguments:
Expand Down Expand Up @@ -103,6 +103,8 @@
#' @importFrom tidyr nest unnest spread
#' @importFrom stats rnorm qnorm lm
#'
#' @author Emma Clegg, \email{emma.clegg@@phe.gov.uk}
#'
#' @export
#'
#' @return The SII with lower and upper confidence limits for each subgroup of the inputted data.frame.
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Status](https://coveralls.io/repos/github/PublicHealthEngland/PHEindicatormethod

# PHEindicatormethods

This is an R package to support analysts in the execution of statistical methods approved for use in the production of PHE indicators such as those presented via Fingertips. It provides functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs and Means, including confidence intervals for these statistics, and a function for assigning data to quantiles.
This is an R package to support analysts in the execution of statistical methods approved for use in the production of PHE indicators such as those presented via Fingertips. It provides functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs, Means, Life Expectancy and Slope Index of Inequaltiy including confidence intervals for these statistics, and a function for assigning data to quantiles.

Any feedback would be appreciated and can be provided using the Issues section of the GitHub repository https://github.com/PublicHealthEngland/PHEindicatormethods, or by emailing PHDS@phe.gov.uk

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
PHEindicatormethods
===================

This is an R package to support analysts in the execution of statistical methods approved for use in the production of PHE indicators such as those presented via Fingertips. It provides functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs and Means, including confidence intervals for these statistics, and a function for assigning data to quantiles.
This is an R package to support analysts in the execution of statistical methods approved for use in the production of PHE indicators such as those presented via Fingertips. It provides functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs, Means, Life Expectancy and Slope Index of Inequaltiy including confidence intervals for these statistics, and a function for assigning data to quantiles.

Any feedback would be appreciated and can be provided using the Issues section of the GitHub repository <https://github.com/PublicHealthEngland/PHEindicatormethods>, or by emailing <PHDS@phe.gov.uk>

Expand Down
34 changes: 14 additions & 20 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,24 @@

## Resubmission
I have amended the description text in the DESCRIPTION file to include doi
<doi:10.prefix.suffix> or
ISBN references to the statistical methods used by the package functions.
I also made the description text more concise.
## First submission of updated package version 1.1.1
This package release v1.1.1 replaces the previous release v1.0.8 currently available on CRAN

I also updated one of the references cited in the function documentation for
the phe_rate, phe_isr and phe_smr functions.
## Amendments in this version
3 new functions have been added:

This package is new to CRAN.
* phe_quantiles
* phe_life_expectancy
* phe_sii

## Description
This is an R package to support analysts in the execution of statistical methods approved for
use in the production of PHE indicators such as those presented via Fingertips. It provides
functions for the generation of Proportions, Rates, DSRs, ISRs, SMRs and Means including
confidence intervals for these statistics.
Also, minor amendments to existing functions. These may result in backwards incompatibility - the circumstances when this may occur are clearly stated in the NEWS.md file and in the function documentation with solutions for how to make old code compatible with the later package version (eg logical 'percentage' argument replaced with numeric 'multiplier' argument - percentage = TRUE equivalent to multiplier = 100 etc).

## Test Environments
* local Windows 7 install, R 3.5.1
* local windows 10 install, R 3.5.1
* used Travis to check on Linux (2018-7-11)
* devtools::build_win() generated 1 note (2018-07-06)
* local windows 10 install, R 3.5.1, 2019-04-17 - OK
* used Travis to check on Linux (2019-04-17) - passed
* devtools::check_win gave 1 NOTE when run on development R 3.6.0 beta,
release R 3.5.3 and oldrelease R 3.4.4 on 2019-04-17. The note related to either possible misspellings or possible invalid urls containing spaces but both are OK.

## R CMD check results
There were no ERRORs or WARNINGs.
R CMD check generated one note (because this is a new package).
There were no ERRORs, WARNINGS or NOTES.

## Downstream dependencies
This is a new package so there are no downstream dependencies
There are no known downstream dependencies
5 changes: 4 additions & 1 deletion man/phe_sii.Rd

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

0 comments on commit 6e9ef4d

Please sign in to comment.