select_neighbours

observation

data

names of variables that shall be used for calculation of distance.
By default these are all variables present in <code>data</code> and <code>observation</code>

variables

the distance function, by default the <code>gower_dist()</code> function.

distance

if <code>n</code> is not specified (NULL), then will be calculated as <code>frac</code> * number of rows in <code>data</code>.
Either <code>n</code> or <code>frac</code> need to be specified.

frac

Function <code>select_neighbours</code> selects subset of rows from data set.
This is useful if data is large and we need just a sample to calculate profiles.

Collection of tools for assessment of feature importance and feature effects.
Key functions are:
feature_importance() for assessment of global level feature importance,
ceteris_paribus() for calculation of the what-if plots,
partial_dependence() for partial dependence plots,
conditional_dependence() for conditional dependence plots,
accumulated_dependence() for accumulated local effects plots,
aggregate_profiles() and cluster_profiles() for aggregation of ceteris paribus profiles,
generic print() and plot() for better usability of selected explainers,
generic plotD3() for interactive, D3 based explanations, and
generic describe() for explanations in natural language.
The package 'ingredients' is a part of the 'DrWhy.AI' universe (Biecek 2018) <arXiv:1806.08915>.

Przemyslaw Biecek

ingredients

Effects and Importances of Model Ingredients

Hubert Baniecki

Adam Izdebski

select_neighbours function

<dl><dt>observation</dt>
<dd>single observation</dd>
<dt>data</dt>
<dd>set of observations</dd>
<dt>variables</dt>
<dd>names of variables that shall be used for calculation of distance.
By default these are all variables present in <code>data</code> and <code>observation</code></dd>
<dt>distance</dt>
<dd>the distance function, by default the <code>gower_dist()</code> function.</dd>
<dt>n</dt>
<dd>number of neighbors to select</dd>
<dt>frac</dt>
<dd>if <code>n</code> is not specified (NULL), then will be calculated as <code>frac</code> * number of rows in <code>data</code>.
Either <code>n</code> or <code>frac</code> need to be specified.</dd></dl>

Arguments

Select Subset of Rows Closest to a Specified Observation — select_neighbours

<dl>

<dt>observation</dt>
<dd>single observation</dd>


<dt>data</dt>
<dd>set of observations</dd>


<dt>variables</dt>
<dd>names of variables that shall be used for calculation of distance.
By default these are all variables present in <code>data</code> and <code>observation</code></dd>


<dt>distance</dt>
<dd>the distance function, by default the <code>gower_dist()</code> function.</dd>


<dt>n</dt>
<dd>number of neighbors to select</dd>


<dt>frac</dt>
<dd>if <code>n</code> is not specified (NULL), then will be calculated as <code>frac</code> * number of rows in <code>data</code>.
Either <code>n</code> or <code>frac</code> need to be specified.</dd>

</dl>

select_neighbours: Select Subset of Rows Closest to a Specified Observation

Description

Usage

Value

Arguments

Details

Examples