mrIML (version 2.2.0)

mrFlashlight: Convert mrIML object into a flashlight object

Description

A wrapper function around flashlight::flashlight() to run multi-response model-agnostic interpretable machine learning analyses. The output can be interrogated using the core functionality of flashlight: see vignette("flashlight", package = "flashlight").

Usage

mrFlashlight(mrIMLobj, response = "multi", index = 1, predict_function = NULL)

Value

A flashlight or multi-flashlight object.

Arguments

mrIMLobj

A list object output by mrIMLpredicts().

response

A character string indicating the type of response: "single" selects one response (indicated by index) and "multi" selects all responses.

index

A numeric value used when response is "single" to select which response column in the data to create a flashlight object for.

predict_function

A function specifying a user-defined prediction function (optional).

Examples

library(flashlight)
library(ggplot2)

mrIML_rf <- mrIML::mrIML_bird_parasites_RF

fl <- mrFlashlight(
  mrIML_rf,
  response = "multi",
  index = 1
)

# Performance comparison
fl %>%
  light_performance(
    metrics = list(`ROC AUC` = MetricsWeighted::AUC)
  ) %>%
  plot() +
  ylim(0, 1)

# Partial dependence curves
fl %>%
  light_profile(data = cbind(mrIML_rf$Data$X, mrIML_rf$Data$Y), "scale.prop.zos") %>%
  plot()

# Two-way partial dependence
fl %>%
  light_profile2d(c("scale.prop.zos", "Plas")) %>%
  plot()