light_check: Check flashlight

In flashlight: Shed Light on Black Box Machine Learning Models

Check flashlight

Description

Checks if an object of class "flashlight" or "multiflashlight" is consistently defined.

Usage

light_check(x, ...)

## Default S3 method:
light_check(x, ...)

## S3 method for class 'flashlight'
light_check(x, ...)

## S3 method for class 'multiflashlight'
light_check(x, ...)

Arguments

x	An object of class "flashlight" or "multiflashlight".
...	Further arguments passed from or to other methods.

Value

The input x or an error message.

Methods (by class)

• light_check(default): Default check method not implemented yet.

• light_check(flashlight): Checks if a flashlight object is consistently defined.

• light_check(multiflashlight): Checks if a multiflashlight object is consistently defined.

Examples

fit <- lm(Sepal.Length ~ ., data = iris)
fit_log <- lm(log(Sepal.Length) ~ ., data = iris)
fl <- flashlight(fit, data = iris, y = "Sepal.Length", label = "ols")
fl_log <- flashlight(fit_log,  y = "Sepal.Length", label = "ols", linkinv = exp)
light_check(fl)
light_check(fl_log)

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