README.md

In jpgard/abroca: Compute and Evaluate Absolute Between-ROC Area

README

abroca

The goal of abroca is to provide basic functionality for computing and visualizing the Absolute Between-ROC Area (ABROCA). In future version of the package, we intend to make further statistical testing procedures for ABROCA available.

Installation

You can install the released version of abroca from CRAN with:

install.packages("abroca")

If you would like to install the latest development version directly from GitHub, you can do so:

# install.packages("devtools")
devtools::install_github("jpgard/abroca")

Example

This is a basic example which demonstrates the use of the abroca package to compute the ABROCA for a simple logistic regression classifier (note that your results may vary due to random sampling):

# install.packages("abroca")
library(abroca)
data("recidivism")
recidivism$returned = as.factor(recidivism$Return.Status != "Not Returned")
in_train = caret::createDataPartition(recidivism$returned, p = 0.75, list = FALSE)
traindata = recidivism[in_train,c("Release.Year", "County.of.Indictment", "Gender", "Age.at.Release", "returned")]
testdata = recidivism[-in_train,c("Release.Year", "County.of.Indictment", "Gender", "Age.at.Release", "returned")]
lr = glm(returned ~ ., data=traindata, family="binomial")
testdata$pred = predict(lr, testdata, type = "response")
abroca <- compute_abroca(testdata, pred_col = "pred", label_col = "returned", 
               protected_attr_col = "Gender", majority_protected_attr_val = "MALE", 
               plot_slices = TRUE, image_dir="./man/figures", identifier="recidivism")
print(abroca)
#> [1] 0.03281967
knitr::include_graphics("man/figures/slice_plot_recidivism_MALE_FEMALE.png")

The plot is automatically saved to a file instead of being displayed on-screen.

For more information, see:

Josh Gardner, Christopher Brooks, and Ryan Baker (2019). Evaluating the Fairness of Predictive Student Models Through Slicing Analysis. Proceedings of the 9th International Conference on Learning Analytics and Knowledge (LAK19); March 4-8, 2019; Tempe, AZ, USA. https://doi.org/10.1145/3303772.3303791

Getting help

If you encounter a clear bug, please file a minimal reproducible example on github, or contact the package maintainers directly (see the package documentation).

jpgard/abroca documentation built on May 25, 2019, 11:31 p.m.