ToolAUCCalculator

R6 class of the AUCCalculator tool

Format

An R6 class object.

Details

ToolAUCCalculator is a wrapper class for the AUCCalculator tool, which is a Java library that provides calculations of ROC and Precision-Recall curves.

See also

This class is derived from ToolIFBase. create_toolset for creating a list of tools.

Super class

prcbench::ToolIFBase -> ToolAUCCalculator

Methods

Public methods

• ToolAUCCalculator$new()

• ToolAUCCalculator$set_jarpath()

• ToolAUCCalculator$set_curvetype()

• ToolAUCCalculator$set_auctype()

• ToolAUCCalculator$clone()

Inherited methods

• prcbench::ToolIFBase$call()
• prcbench::ToolIFBase$get_auc()
• prcbench::ToolIFBase$get_result()
• prcbench::ToolIFBase$get_setname()
• prcbench::ToolIFBase$get_toolname()
• prcbench::ToolIFBase$get_x()
• prcbench::ToolIFBase$get_y()
• prcbench::ToolIFBase$print()
• prcbench::ToolIFBase$set_setname()
• prcbench::ToolIFBase$set_toolname()

---

Method new()

Default class initialization method.

Usage

ToolAUCCalculator$new(...)

Arguments

...

set value for jarpath.

---

Method set_jarpath()

It sets an AUCCalculator jar file.

Usage

ToolAUCCalculator$set_jarpath(jarpath = NULL)

Arguments

jarpath

File path of the AUCCalculator jar file, e.g. "/path1/path2/auc2.jar".

---

Method set_curvetype()

It sets the type of curve.

Usage

ToolAUCCalculator$set_curvetype(curvetype = "SPR")

Arguments

curvetype

"SPR", "PR", or "ROC"

---

Method set_auctype()

It sets the type of calculation method

Usage

ToolAUCCalculator$set_auctype(auctype)

Arguments

auctype

"java" or "r"

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ToolAUCCalculator$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Initialization
toolauccalc <- ToolAUCCalculator$new()

## Show object info
toolauccalc
#> 
#>     === Tool interface ===
#> 
#>     Tool name:            AUCCalculator 
#>     Calculate AUC score:  Yes
#>     Store results:        Yes
#>     Prediction performed: No
#>     Available methods:    call(testset, calc_auc, store_res)
#>                           get_toolname()
#>                           set_toolname(toolname)
#>                           get_setname()
#>                           set_setname(setname)
#>                           get_result()
#>                           get_x()
#>                           get_y()
#>                           get_auc()
#>                           set_jarpath(jarpath)
#>                           set_curvetype(curvetype)
#>                           set_auctype(auctype)
#>     Help file:            help("ToolAUCCalculator")

## create_toolset should be used for benchmarking and curve evaluation
toolauccalc2 <- create_toolset("AUCCalculator")