Toolyardstick

R6 class of the yardstick tool

Format

An R6 class object.

Details

Toolyardstick is a wrapper class for the yardstick tool, which is an R library of the tidymodels ecosystem that provides calculations of various model performance measures.

See also

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

Super class

ToolIFBase -> Toolyardstick

Methods

Public methods

• Toolyardstick$clone()

Inherited methods

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

---

Toolyardstick$clone()

The objects of this class are cloneable with this method.

Usage

Toolyardstick$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Initialization
toolyardstick <- Toolyardstick$new()

## Show object info
toolyardstick
#> 
#>     === Tool interface ===
#> 
#>     Tool name:            yardstick 
#>     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()
#>     Help file:            help("Toolyardstick")

## create_toolset should be used for benchmarking and curve evaluation
toolyardstick2 <- create_toolset("yardstick")