All functions

add_predictions()

Add black box predictions to generated dataset

add_predictions2()

Add black box predictions to generated dataset

calculate_weights()

Calculate weights for explanation model

check_conditions()

Check if data, explained instance and size make sense.

check_for_na()

Alert user if NAs are present

create_task()

Create regression or classification task.

euclidean_kernel()

LIME kernel equal to the inverse of euclidean distance.

fit_explanation()

Fit white box model to the simulated data.

fit_explanation2()

Fit white box model to the simulated data.

gaussian_kernel()

LIME kernel from the original article with sigma = 1.

generate_neighbourhood()

LIME: sampling for local exploration

generate_neighbourhood2()

LIME: sampling for local exploration by changing one value per observation.

give_predictions()

Add predictions to generated dataset.

give_predictions2()

Add predictions to generated dataset.

identity_kernel()

LIME kernel that treats all observations as equally similar to observation of interest.

live

live: visualizing interpretable models to explain black box models.

live_shiny()

Function that starts a Shiny app which helps use LIVE.

local_permutation_importance()

Local permutation variable importance

normal_neighbourhood()

LIME: sampling for local exploration using normal distribution.

permutation_neighbourhood()

LIME: sampling for local exploration by permuting all columns.

plot(<live_explainer>)

Plotting white box models.

plot(<local_permutation_importance>)

Plot local permutation importance

plot_explanation()

Plotting white box models.

plot_explanation2()

Plotting white box models.

plot_regression()

Waterfall plot or forestplot for lm/glm explanations.

plot_regression2()

Waterfall plot or forestplot for lm/glm explanations.

print(<live_explainer>)

Generic print function for live explainer

print(<live_explorer>)

Generic print function for class live_explorer

print(<local_permutation_importance>)

Print method for local_permutation_importance class

sample_locally()

Generate dataset for local exploration. DEPRECATED. Please refer to sample_locally2 function for updated and improved interface. This function will be removed in the future and was left only to remain consistent with the examples given in https://arxiv.org/abs/1804.01955. For more, see NEWS and vignette.

sample_locally2()

Generate dataset for local exploration.

select_variables()

Select variables for explanation model.

set_constant_dates()

Set date values to one value

set_constant_variables()

Set date values to one value

wine

Red wine characteristics and quality.