eval_distance

This function serves as an evaluation wrapper for some distance function. It checks that the output
of <code>distance_function</code> is a <code>numeric</code> matrix with <code>nrow(x)</code> rows and <code>nrow(y)</code> columns as expected.

Modular and unified R6-based interface for counterfactual explanation methods.
The following methods are currently implemented: Burghmans et al. (2022) <doi:10.48550/arXiv.2104.07411>,
Dandl et al. (2020) <doi:10.1007/978-3-030-58112-1_31> and Wexler et al. (2019) <doi:10.1109/TVCG.2019.2934619>.
Optional extensions allow these methods to be applied to a variety of models and use cases.
Once generated, the counterfactuals can be analyzed and visualized by provided functionalities.

Susanne Dandl

counterfactuals

Counterfactual Explanations

Andreas Hofheinz

Martin Binder

Giuseppe Casalicchio

eval_distance function

<dl><dt>distance_function</dt>
<dd>(<code>function()</code>) 
A distance function to evaluate.</dd>
<dt>x</dt>
<dd>(<code>data.frame() | numeric()</code>) 
A matrix or a data frame containing variables that should be used in the computation of the distance.</dd>
<dt>y</dt>
<dd>(<code>data.frame() | numeric()</code>) 
A matrix or a data.frame containing variables that should be used in the computation of the distance.</dd>
<dt>data</dt>
<dd>(<code><a href="/link/data.frame()?package=counterfactuals&version=0.1.6" data-mini-rdoc="counterfactuals::data.frame()">data.frame()</a></code> | <code>NULL</code>) 
A data.frame or data.table containing the entire data set. This can be used to compute statistics used in the
computation of the distance, e.g., standard deviation or range.</dd></dl>

Arguments

Evaluates a distance function and checks for correct output format — eval_distance

<dl>

<dt>distance_function</dt>
<dd>(<code>function()</code>) 
A distance function to evaluate.</dd>


<dt>x</dt>
<dd>(<code>data.frame() | numeric()</code>) 
A matrix or a data frame containing variables that should be used in the computation of the distance.</dd>


<dt>y</dt>
<dd>(<code>data.frame() | numeric()</code>) 
A matrix or a data.frame containing variables that should be used in the computation of the distance.</dd>


<dt>data</dt>
<dd>(<code><a href='https://rdrr.io/r/base/data.frame.html'>data.frame()</a></code> | <code>NULL</code>) 
A data.frame or data.table containing the entire data set. This can be used to compute statistics used in the
computation of the distance, e.g., standard deviation or range.</dd>

</dl>

eval_distance: Evaluates a distance function and checks for correct output format

Description

Usage

Arguments