Package index • ale

ALE creation and manipulation

Create and manipulate ALE S7 objects for data and statistics for accumulated local effects.

ALE(): ALE data and statistics that describe a trained model
print-ALE-method: print Method for ALE object
summary-ALE-method: summary Method for ALE object
get-ALE-method: get method for ALE objects
plot-ALE-method: plot method for ALE objects
invert_probs(): Invert ALE Probabilities

Advanced visualization

Generate ALEPlots S7 objects, manipulate them, and plot ALE.

ALEPlots(): ALE plots with print and plot methods
print-ALEPlots-method: Print method for ALEPlots object
plot-ALEPlots-method: Plot method for ALEPlots object
customize(): Customize plots contained in an ALEPlots object
summary-ALEPlots-method: summary method for ALEPlots object
get-ALEPlots-method: get method for ALEPlots objects
subset-ALEPlots-method: subset method for ALEPlots object

p-values

Create ALEpDist S7 objects for p-values distributions for ALE statistics.

ALEpDist(): Random variable distributions of ALE statistics for generating p-values

Full-model bootstrapping

Bootstrap a full model with a ModelBoot S7 object, with ALE and other calculations.

ModelBoot(): Statistics and ALE data for a bootstrapped model
print-ModelBoot-method: print method for ModelBoot object
summary-ModelBoot-method: summary Method for ModelBoot object
plot-ModelBoot-method: plot method for ModelBoot objects
get-ModelBoot-method: get method for ModelBoot objects

S7 generics

get(): S7 generic get method for objects in the ale package

Supporting utilities

Helper functions for data preparation and analysis.

resolve_x_cols(): Resolve x_cols and exclude_cols to their standardized format
retrieve_rds(): Retrieve an R object from the first successful source among multiple attempts
x_medoids(): k-medoids across a range, returning all internal cluster-quality measures

Example datasets

Datasets for illustrating ALE analysis.

var_cars: Multi-variable transformation of the mtcars dataset.
census: Census Income