summary.optimal.cutpoints: Summary method for optimal.cutpoints objects

Description

Produces a summary of a optimal.cutpoints object. The following are printed: the call to the optimal.cutpoints() function; the optimal cutpoint(s) obtained with the method(s) selected; its/their accuracy measures and the area under ROC curve (AUC) estimates at each categorical covariate level (if the categorical.cov argument in the optimal.cutpoints() function is not NULL). If optimal.cutpoints() was called with the ci.fit = TRUE argument, confidence intervals for accuracy measures at the optimal cutpoint are also printed.

Usage

# S3 method for optimal.cutpoints
summary(object, ...)

Arguments

object

an object of class optimal.cutpoints as produced by optimal.cutpoints()

…

further arguments passed to or from other methods. None are used in this method.

Value

Returns an object of class "summary.optimal.cutpoints" with the same components as the optimal.cutpoints function (see optimal.cutpoints) plus:

p.table

a list with all the numerical information to be shown on the screen.

Details

The summary.optimal.cutpoints function produces a list of summary information for a fitted optimal.cutpoints object. The result depends on the three arguments, namely, methods, categorical.cov and ci.fit of the optimal.cutpoints() function used in the optimal cutpoints computing process.

Examples

Run this code

# NOT RUN {
library(OptimalCutpoints)
data(elas)
###########################################################
# Youden Index Method ("Youden"): Covariate gender
###########################################################
optimal.cutpoint.Youden<-optimal.cutpoints(X = "elas", status = "status", tag.healthy = 0, 
methods = "Youden", data = elas, pop.prev = NULL, categorical.cov = "gender", 
control = control.cutpoints(), ci.fit = TRUE, conf.level = 0.95, trace = FALSE)

summary(optimal.cutpoint.Youden) 
# }