- object
A fitted model object (e.g., a "randomForest"
object) or
an object that inherits from class "vi"
.
- ...
Additional optional arguments to be passed on to
vi_model
, vi_firm
, vi_permute
,
or vi_shap
.
- method
Character string specifying the type of variable importance
(VI) to compute. Current options are "model"
(the default), for
model-specific VI scores (see vi_model
for details),
"firm"
, for variance-based VI scores (see vi_firm
for
details), "permute"
, for permutation-based VI scores (see '
vi_permute
for details), or "shap"
, for Shapley-based
VI scores. For more details on the variance-based methods, see
Greenwell et al. (2018) and
Scholbeck et al. (2019).
- feature_names
Character string giving the names of the predictor
variables (i.e., features) of interest.
- FUN
Deprecated. Use var_fun
instead.
- var_fun
List with two components, "cat"
and "con"
,
containing the functions to use to quantify the variability of the feature
effects (e.g., partial dependence values) for categorical and continuous
features, respectively. If NULL
, the standard deviation is used for
continuous features. For categorical features, the range statistic is used
(i.e., (max - min) / 4). Only applies when method = "firm"
.
- ice
Logical indicating whether or not to estimate feature effects
using individual conditional expectation (ICE) curves.
Only applies when method = "firm"
. Default is FALSE
. Setting
ice = TRUE
is preferred whenever strong interaction effects are
potentially present.
- abbreviate_feature_names
Integer specifying the length at which to
abbreviate feature names. Default is NULL
which results in no
abbreviation (i.e., the full name of each feature will be printed).
- sort
Logical indicating whether or not to order the sort the variable
importance scores. Default is TRUE
.
- decreasing
Logical indicating whether or not the variable importance
scores should be sorted in descending (TRUE
) or ascending
(FALSE
) order of importance. Default is TRUE
.
- scale
Logical indicating whether or not to scale the variable
importance scores so that the largest is 100. Default is FALSE
.
- rank
Logical indicating whether or not to rank the variable
importance scores (i.e., convert to integer ranks). Default is FALSE
.
Potentially useful when comparing variable importance scores across different
models using different methods.