Learn R Programming

pROC (version 1.3.1)

ci.sp: Compute the confidence interval of specificities at given sensitivities

Description

This function computes the confidence interval (CI) of the specificity at the given sensitivity points. By default, the 95% CI are computed with 2000 stratified bootstrap replicates.

Usage

ci.sp(...)
## S3 method for class 'roc':
ci.sp(roc, sensitivities = seq(0, 1, .1) * ifelse(roc$percent,
100, 1), conf.level=0.95, boot.n=2000, boot.stratified=TRUE,
progress=getOption("pROCProgress")$name, ...) 
## S3 method for class 'smooth.roc':
ci.sp(smooth.roc, sensitivities = seq(0, 1, .1) *
ifelse(smooth.roc$percent, 100, 1), conf.level=0.95, boot.n=2000,
boot.stratified=TRUE, progress=getOption("pROCProgress")$name, ...)
## S3 method for class 'formula':
ci.sp(formula, data, ...)
## S3 method for class 'default':
ci.sp(response, predictor, ...)

Arguments

roc, smooth.roc
a roc object from the roc function, or a smooth.roc object from the smooth.roc function.
response, predictor
arguments for the roc function.
formula, data
a formula (and possibly a data object) of type response~predictor for the roc function.
sensitivities
on which sensitivities to evaluate the CI.
conf.level
the width of the confidence interval as [0,1], never in percent. Default: 0.95, resulting in a 95% CI.
boot.n
the number of bootstrap replicates. Default: 2000.
boot.stratified
should the bootstrap be stratified (default, same number of cases/controls in each replicate than in the original sample) or not.
progress
the name of progress bar to display. Typically none, win, tk or text (see the name argument to create_progress_b
...
further arguments passed to or from other methods, especially arguments for roc and ci.sp.roc when calling ci.sp.default or ci.sp.formula. Arguments for

Value

  • A matrix of CI for the given specificities. Row (names) are the sensitivities, the first column the lower bound, the 2nd column the median and the 3rd column the upper bound.

    Additionally, the list has the following attributes:

  • conf.levelthe width of the CI, in fraction.
  • boot.nthe number of bootstrap replicates.
  • boot.stratifiedwhether or not the bootstrapping was stratified.
  • sensitivitiesthe sensitivities as given in argument.
  • rocthe object of class roc that was used to compute the CI.

encoding

UTF-8

Warnings

If boot.stratified=FALSE and the sample has a large imbalance between cases and controls, it could happen that one or more of the replicates contains no case or control observation, or that there are not enough points for smoothing, producing a NA area. The warning NA value(s) produced during bootstrap were ignored. will be issued and the observation will be ignored. If you have a large imbalance in your sample, it could be safer to keep boot.stratified=TRUE.

Errors

If density.cases and density.controls were provided for smoothing, the error Cannot compute the statistic on ROC curves smoothed with density.controls and density.cases. is issued.

Details

ci.sp.formula and ci.sp.default are convenience methods that build the ROC curve (with the roc function) before calling ci.sp.roc. You can pass them arguments for both roc and ci.sp.roc. Simply use ci.sp that will dispatch to the correct method. The ci.sp.roc function creates boot.n bootstrap replicate of the ROC curve, and evaluates the specificity at sensitivities given by the sensitivities argument. Then it computes the confidence interval as the percentiles given by conf.level.

Stratification of bootstrap can be controlled with boot.stratified. In stratified bootstrap, each replicate contains the same number of cases and controls than the original sample. Stratification is especially useful if one group has only little observations, or if groups are not balanced. Higher numbers of boot.n will give a more precise estimate of the CI, but take more time to compute. 2000 is recommanded by Carpenter and Bithell.

For smoothed ROC curves, smoothing is performed again at each bootstrap replicate with the parameters originally provided. If a density smoothing was performed with user-provided density.cases or density.controls the bootstrap cannot be performed and an error is issued.

References

Tom Fawcett (2006) ``An introduction to ROC analysis''. Pattern Recognition Letters 27, 861--874. DOI: 10.1016/j.patrec.2005.10.010.

James Carpenter and John Bithell (2000) ``Bootstrap condence intervals: when, which, what? A practical guide for medical statisticians''. Statistics in Medicine 19, 1141--1164.

See Also

roc, ci, ci.se, plot.ci

Examples

Run this code
data(aSAH)

# Syntax (response, predictor):
ci.sp(aSAH$outcome, aSAH$s100b)

# With a roc object:
rocobj <- roc(aSAH$outcome, aSAH$s100b)
ci.sp(rocobj)

# Customized bootstrap and specific specificities:
ci.sp(rocobj, c(.95, .9, .85), boot.n=500, conf.level=0.9, stratified=FALSE)

# Alternatively, you can get the CI directly from roc():
rocobj <- roc(aSAH$outcome,
              aSAH$s100b, ci=TRUE, of="sp", boot.n=100)
rocobj$ci

# Plotting the CI
plot(rocobj)
plot(rocobj$ci)

# On a smoothed ROC, the CI is re-computed automatically
smooth(rocobj)
# Or you can compute a new one:
ci.sp(smooth(rocobj, method="density", reuse.ci=FALSE), boot.n=100)

Run the code above in your browser using DataLab