/PHEindicatormethods

Primary LanguageR

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 and Means including confidence intervals for these statistics.

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

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

install.packages("PHEindicatormethods")

Install a development version from GitHub using devtools

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

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

devtools::install_github("PublicHealthEngland/PHEindicatormethods",
                         build_vignettes = TRUE,
                         dependencies = "suggests")

Install a development version from zip

Download the PHEindicatormethods repository from GitHub https://github.com/PublicHealthEngland/PHEindicatormethods and either build from source or do:

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

source <- devtools:::source_pkg("C:/path/to/PHEindicatormethods-master")
devtools::install(source)



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:

  • byars_lower
  • byars_upper
  • phe_dsr
  • phe_isr
  • phe_mean
  • phe_proportion
  • phe_rate
  • phe_smr
  • wilson_lower
  • wilson_upper

Datasets:

  • esp2013

Vignettes:

  • Vignette to introduce the package functions included in the original package release
  • Vignette for calculating DSRs for multiple geographies and time periods

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