Measure Registry

The environment() measures keeps track of all measures in this package. It stores meta information such as minimum, maximum or if the measure must be minimized or maximized. The following information is available for each measure:

• id: Name of the measure.

• title: Short descriptive title.

• type: "binary" for binary classification, "classif" for binary or multi-class classification, "regr" for regression and "similarity" for similarity measures.

• lower: lower bound.

• upper: upper bound.

• predict_type: prediction type the measure operates on. "response" corresponds to class labels for classification and the numeric response for regression. "prob" corresponds to class probabilities, provided as a matrix with class labels as column names. "se" corresponds to to the vector of predicted standard errors for regression.

• minimize: If TRUE or FALSE, the objective is to minimize or maximize the measure, respectively. Can also be NA.

• obs_loss: Name of the function which is called to calculate the (unaggregated) loss per observation.

• trafo: Optional list() of length 2, containing a transformation "fn" and its derivative "deriv".

• aggregated: If TRUE, this function aggregates the losses to a single numeric value. Otherwise, a vector of losses is returned.

• sample_weights: If TRUE, it is possible calculate a weighted measure.

Usage

measures

Format

An object of class environment of length 65.

Examples

names(measures)
#>  [1] "rmsle"       "one_zero"    "mauc_au1u"   "rse"         "bbrier"     
#>  [6] "msle"        "maxae"       "zero_one"    "tnr"         "sse"        
#> [11] "pbias"       "mauc_aunp"   "precision"   "smape"       "fomr"       
#> [16] "mae"         "phi"         "tn"          "ape"         "mauc_aunu"  
#> [21] "pinball"     "fnr"         "tp"          "srho"        "ae"         
#> [26] "rsq"         "jaccard"     "npv"         "sle"         "dor"        
#> [31] "bacc"        "ppv"         "medse"       "auc"         "rae"        
#> [36] "sae"         "rmse"        "ktau"        "tpr"         "mcc"        
#> [41] "linex"       "fn"          "maxse"       "gmean"       "fp"         
#> [46] "bias"        "fdr"         "prauc"       "logloss"     "mauc_mu"    
#> [51] "mse"         "fpr"         "mbrier"      "ce"          "recall"     
#> [56] "gpr"         "specificity" "se"          "rrse"        "acc"        
#> [61] "fbeta"       "medae"       "sensitivity" "mape"        "mauc_au1p"  
measures$tpr
#> $id
#> [1] "tpr"
#> 
#> $title
#> [1] "True Positive Rate"
#> 
#> $type
#> [1] "binary"
#> 
#> $lower
#> [1] 0
#> 
#> $upper
#> [1] 1
#> 
#> $predict_type
#> [1] "response"
#> 
#> $minimize
#> [1] FALSE
#> 
#> $obs_loss
#> [1] NA
#> 
#> $aggregated
#> [1] TRUE
#> 
#> $sample_weights
#> [1] FALSE
#> 
#> $trafo
#> [1] NA
#>