Learn R Programming

⚠️There's a newer version (2.1.0) of this package.Take me there.

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

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:

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

Datasets:

  • esp2013
  • LE_data (for use with SII vignette)
  • DSR_data (for use with SII vignette)
  • prevalence_data (for use with SII vignette)

Vignettes:

  • Vignette to introduce the package functions included in the original package release
  • 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)

Copy Link

Version

Install

install.packages('PHEindicatormethods')

Monthly Downloads

513

Version

1.1.5

License

GPL-3

Maintainer

Anderson Georgina

Last Published

September 11th, 2019

Functions in PHEindicatormethods (1.1.5)

SimulationFunc

SimulationFunc
FindXValues

FindXValues
byars_upper

byars_upper
PHEindicatormethods

PHEindicatormethods: A package for performing standard statistics for public health indicators
DSR_data

SII test datasets - DSR
na.zero

Convert NAs to zeros using na.zero
phe_dsr

Calculate Directly Standardised Rates using phe_dsr
LE_data

SII test datasets - Life Expectancy
esp2013

European Standard Population 2013
phe_quantile

Assign Quantiles using phe_quantile
phe_sii

Calculate Slope Index of Inequality using phe_sii
phe_smr

Calculate Standardised Mortality Ratios using phe_smr
prevalence_data

SII test datasets - Prevalence
phe_rate

Calculate Rates using phe_rate
phe_life_expectancy

Calculate Life Expectancy using phe_life_expectancy
phe_isr

Calculate Indirectly Standardised Rates using phe_isr
wilson_lower

wilson_lower
wilson_upper

wilson_upper
phe_proportion

Calculate Proportions using phe_proportion
phe_mean

Calculate Means using phe_mean
byars_lower

byars_lower