is.flashlight: Check functions for flashlight Classes

In flashlight: Shed Light on Black Box Machine Learning Models

Check functions for flashlight Classes

Description

Checks if an object inherits specific class relevant for the flashlight package.

Usage

is.flashlight(x)

is.multiflashlight(x)

is.light(x)

is.light_performance(x)

is.light_performance_multi(x)

is.light_importance(x)

is.light_importance_multi(x)

is.light_breakdown(x)

is.light_breakdown_multi(x)

is.light_ice(x)

is.light_ice_multi(x)

is.light_profile(x)

is.light_profile_multi(x)

is.light_profile2d(x)

is.light_profile2d_multi(x)

is.light_effects(x)

is.light_effects_multi(x)

is.shap(x)

is.light_scatter(x)

is.light_scatter_multi(x)

is.light_global_surrogate(x)

is.light_global_surrogate_multi(x)

Arguments

x	Any object.

Value

A logical vector of length one.

Functions

• is.multiflashlight(): Check for multiflashlight object.

• is.light(): Check for light object.

• is.light_performance(): Check for light_performance object.

• is.light_performance_multi(): Check for light_performance_multi object.

• is.light_importance(): Check for light_importance object.

• is.light_importance_multi(): Check for light_importance_multi object.

• is.light_breakdown(): Check for light_breakdown object.

• is.light_breakdown_multi(): Check for light_breakdown_multi object.

• is.light_ice(): Check for light_ice object.

• is.light_ice_multi(): Check for light_ice_multi object.

• is.light_profile(): Check for light_profile object.

• is.light_profile_multi(): Check for light_profile_multi object.

• is.light_profile2d(): Check for light_profile2d object.

• is.light_profile2d_multi(): Check for light_profile2d_multi object.

• is.light_effects(): Check for light_effects object.

• is.light_effects_multi(): Check for light_effects_multi object.

• is.shap(): Check for shap object.

• is.light_scatter(): Check for light_scatter object.

• is.light_scatter_multi(): Check for light_scatter_multi object.

• is.light_global_surrogate(): Check for light_global_surrogate object.

• is.light_global_surrogate_multi(): Check for light_global_surrogate_multi object.

Examples

a <- flashlight(label = "a")
is.flashlight(a)
is.flashlight("a")

flashlight documentation built on May 31, 2023, 6:19 p.m.