KPI_summary_table.as_data: KPI summary table

View source: R/tables.R

KPI_summary_table.as_dataR Documentation

KPI summary table

Description

Function that generates a summary table of the KPI values. Optimal is the value of the KPI when choosing the best option for each instance. It's the best that we could do with respect to that KPI. Best is the value of the KPI for the best option overall according to the KPI. ML is the value of the KPI choosing for each instance the option selected by the learning.

Usage

## S3 method for class 'as_data'
KPI_summary_table(
  data_object,
  predictions = NULL,
  test = TRUE,
  normalized = FALSE,
  ...
)

Arguments

data_object

an object of class as_data.

predictions

a data frame with the predicted KPI for each algorithm (columns) and for each instance (rows). If NULL, the table won't include a ML column.

test

flag that indicates whether the function should use test data or training data.

normalized

whether to use the original values of the KPI or the normalized ones used for the learning.

...

other parameters.

Value

A table with the statistics of the pace.

Examples

data(branchingsmall)
data_object <- partition_and_normalize(branchingsmall$x, branchingsmall$y, test_size = 0.3,
family_column = 1, split_by_family = TRUE)
training <- AStrain(data_object, method = "glm")
predictions <- ASpredict(training, newdata = data_object$x.test)
KPI_summary_table(data_object, predictions = predictions)

ASML documentation built on Nov. 10, 2026, 1:06 a.m.