CalculateHUM_ROC {HUM}R Documentation

Calculate HUM value

Description

This is the function of the HUM package for computing th enpoints for ROC curve. It returns a “List” object, consisting of sensitivity and specificity values for 2D-ROC curve and 3D-points for 3D-ROC curve. Also the optimal threshold values are returned.

Usage

CalculateHUM_ROC(data,indexF,indexClass,indexLabel,seq)

Arguments

data

a dataset, a matrix of feature values for several cases, the additional column with class labels is provided. Class labels could be numerical or character values. The maximal number of classes is ten. The indexClass determines the column with class labels.

indexF

a numeric or character vector, containing the column numbers or column names of the analyzed features.

indexClass

a numeric or character value, containing the column number or column name of the class labels.

indexLabel

a character vector, containing the column names of the class labels, selected for the analysis.

seq

a numeric matrix, containing the permutation of the class labels for all features.

Details

This function's main job is to compute the point coordinates to plot the 2D- or 3D-ROC curve and the optimal threshold values. See the “Value” section to this page for more details. The function calls the CalcROC to calculate the point coordinates, optimal thresholds and accuracy of classifier (feature) in the threshold.

Data can be provided in matrix form, where the rows correspond to cases with feature values and class label. The columns contain the values of individual features and the separate column contains class labels. The maximal number of class labels equals 10.

Value

The data must be provided without missing values in order to process. A returned list consists of th the following fields:

Sn

a specificity values for 2D-ROC construction and the first coordinate for 3D-ROC construction

Sp

a sensitivity values for 2D-ROC construction and the second coordinate for 3D-ROC construction

S3

the third coordinate for 3D-ROC construction

optSn

the optimal specificity value for 2D-ROC construction and the first coordinate of the op-timal threshold for 3D-ROC construction

optSp

the optimal sensitivity value for 2D-ROC construction and the second coordinate of the optimal threshold for 3D-ROC construction

optS3

the third coordinate of the optimal threshold for 3D-ROC construction

Errors

If there exists NA values for features or class labels no HUM value can be calculated and an error is triggered with message “Values are missing”.

References

Li, J. and Fine, J. P. (2008): ROC Analysis with Multiple Tests and Multiple Classes: methodology and its application in microarray studies.Biostatistics. 9 (3): 566-576.

See Also

CalculateHUM_Ex, CalculateHUM_seq

Examples

data(sim)
# Basic example
indexF=names(sim[,c(3),drop = FALSE])
indexClass=2
label=unique(sim[,indexClass])
indexLabel=label[1:2]
out=CalculateHUM_seq(sim,indexF,indexClass,indexLabel)
HUM<-out$HUM
seq<-out$seq
out=CalculateHUM_ROC(sim,indexF,indexClass,indexLabel,seq)

[Package HUM version 2.0 Index]