get_data_specs: Fetches feature information from a given data set

In NorskRegnesentral/shapr: Prediction Explanation with Dependence-Aware Shapley Values

Fetches feature information from a given data set

Description

Fetches feature information from a given data set

Usage

get_data_specs(x)

Arguments

x	data.frame or data.table. The data to extract feature information from.

Details

This function is used to extract the feature information to be checked against the corresponding information extracted from the model and other data sets. The function is only called internally

Value

A list with the following elements:

labels

character vector with the feature names to compute Shapley values for

classes

a named character vector with the labels as names and the class types as elements

factor_levels

a named list with the labels as names and character vectors with the factor levels as elements (NULL if the feature is not a factor)

Author(s)

Martin Jullum

Examples

# Load example data
## Not run: 
data("airquality")
airquality <- airquality[complete.cases(airquality), ]
# Split data into test- and training data
x_train <- head(airquality, -3)
x_explain <- tail(airquality, 3)
# Split data into test- and training data
x_train <- data.table::as.data.table(head(airquality))
x_train[, Temp := as.factor(Temp)]
shapr:::get_data_specs(x_train)

## End(Not run)

NorskRegnesentral/shapr documentation built on Feb. 11, 2025, 6:41 a.m.