SimulationFunc

data.frame containing the data to calculate SII confidence limits
from; unquoted string; no default

data

field name within data that contains the indicator value; unquoted
string; no default

value

indicates the indicator type (1 = rate, 2 = proportion, 0 = other);
integer; default 0

value_type

field name within data that contains the standard error of the indicator
value; unquoted string; no default

number of random samples to perform to return confidence interval of SII;
numeric; default 100,000

repeats

confidence level used to calculate the lower and upper confidence limits of SII;
numeric between 0.5 and 0.9999 or 50 and 99.99; default 0.95

confidence

field name within dataset containing square root of a values;
unquoted string; no default

sqrt_a

field name within dataset containing square root of a values multiplied
by b values;unquoted string; no default

b_sqrt_a

option to return the Relative Index of Inequality (RII) with associated confidence limits
as well as the SII; logical; default FALSE

option to carry out the SII confidence interval simulation 10 times instead
of once and return the Mean Average Difference between the first and subsequent samples (as a
measure of the amount of variation); logical; default FALSE

reliability_stat

Function to simulate SII range through random sampling of the indicator value
for each quantile, based on the associated mean and standard error

Functions to calculate commonly used public health statistics and
their confidence intervals using methods approved for use in the production
of Public Health England indicators such as those presented via Fingertips
(<http://fingertips.phe.org.uk/>). It provides functions for the generation
of proportions, crude rates, means, directly standardised rates, indirectly
standardised rates, standardised mortality ratios, slope and relative index
of inequality and life expectancy.
Statistical methods are referenced in the following publications.
Breslow NE, Day NE (1987) <doi:10.1002/sim.4780080614>.
Dobson et al (1991) <doi:10.1002/sim.4780100317>.
Armitage P, Berry G (2002) <doi:10.1002/9780470773666>.
Wilson EB. (1927) <doi:10.1080/01621459.1927.10502953>.
Altman DG et al (2000, ISBN: 978-0-727-91375-3).
Chiang CL. (1968, ISBN: 978-0-882-75200-6).
Newell C. (1994, ISBN: 978-0-898-62451-9).
Eayres DP, Williams ES (2004) <doi:10.1136/jech.2003.009654>.
Silcocks PBS et al (2001) <doi:10.1136/jech.55.1.38>.
Low and Low (2004) <doi:10.1093/pubmed/fdh175>.

SimulationFunc: SimulationFunc

Description

Usage

Arguments

Value