plot_sankey

Visualises routing from Actual Group -&gt; Assigned Expert (2-axis), or
Actual Group -&gt; Learned Feature Profile -&gt; Assigned Expert (3-axis)
when feature mapping is available.

Tools for training and analysing fairness-aware gated neural
networks for subgroup-aware prediction and interpretation in clinical datasets.
Methods draw on prior work in mixture-of-experts neural networks by
Jordan and Jacobs (1994) <doi:10.1007/978-1-4471-2097-1_113>,
fairness-aware learning by Hardt, Price, and Srebro (2016) <doi:10.48550/arXiv.1610.02413>,
and personalised treatment prediction for depression by Iniesta, Stahl, and McGuffin (2016)
<doi:10.1016/j.jpsychires.2016.03.016>.

Rhys Holland

fairGATE

Fair Gated Algorithm for Targeted Equity

plot_sankey function

<dl><dt>prepared_data</dt>
<dd>List from <code>prepare_data()</code>; used for group labels and (optionally) feature mapping.
Needs <code>feature_names</code> for 3-axis; <code>subject_ids</code> to align subjects to X.</dd>
<dt>gnn_results</dt>
<dd>List from <code>train_gnn()</code>; uses $final_results and $gate_weights.</dd>
<dt>expert_results</dt>
<dd>Optional list from <code>analyse_experts()</code>; used only for picking opposed features in 3-axis.</dd>
<dt>top_n_per_side</dt>
<dd>Integer; number of features per side to define Profile A/B (default 2) for 3-axis.</dd>
<dt>use_profiles</dt>
<dd>Logical; try 3-axis when possible (default TRUE). If FALSE, always do 2-axis.</dd>
<dt>verbose</dt>
<dd>Logical; print progress.</dd></dl>

Arguments

Create a Sankey Plot (robust; aggregates to one row per subject) — plot_sankey

<dl>

<dt>prepared_data</dt>
<dd>List from <code>prepare_data()</code>; used for group labels and (optionally) feature mapping.
Needs <code>feature_names</code> for 3-axis; <code>subject_ids</code> to align subjects to X.</dd>


<dt>gnn_results</dt>
<dd>List from <code>train_gnn()</code>; uses $final_results and $gate_weights.</dd>


<dt>expert_results</dt>
<dd>Optional list from <code>analyse_experts()</code>; used only for picking opposed features in 3-axis.</dd>


<dt>top_n_per_side</dt>
<dd>Integer; number of features per side to define Profile A/B (default 2) for 3-axis.</dd>


<dt>use_profiles</dt>
<dd>Logical; try 3-axis when possible (default TRUE). If FALSE, always do 2-axis.</dd>


<dt>verbose</dt>
<dd>Logical; print progress.</dd>

</dl>

plot_sankey: Create a Sankey Plot (robust; aggregates to one row per subject)

Description

Usage

Value

Arguments