Build Status

Coverage Status

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, 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



Installation

Install from CRAN

14/05/2019: Please note that this package is temporarily unavailable on CRAN due to issues on non-windows platforms using clang as compiler. Whilst these are addressed please install from GitHub

Install the latest release version of PHEindicatormethods directly from CRAN with:

install.packages("PHEindicatormethods")



Install a development version from GitHub using remotes package

You can install a development version of PHEindicatormethods from GitHub with:

if (!require(remotes)) install.packages("remotes")

remotes::install_github("PublicHealthEngland/PHEindicatormethods",
                         build_vignettes = TRUE,
                         dependencies = TRUE,
                         build_opts = c("--no-resave-data"))



Package Versioning

Following installation of this package, type ‘packageVersion(“PHEindicatormethods”)’ in the R console to show the package version. If it is suffixed with a 9000 number then you are using an unapproved development version.

Released versions of this package will have version numbers consisting of three parts:

major.minor.patch

In-development versions of this package will have a fourth component, the development version number, which will increment from 9000.

See http://r-pkgs.had.co.nz/description.html for further information on package versioning



Package Contents

The package contains the following functions, datasets and vignettes - see individual item documentation for full details

Functions:

Datasets:

Vignettes:

(type ‘browseVignettes(“PHEindicatormethods”)’ to view in HTML)