groupmetric_2panel {SPARRAfairness}

groupmetric_2panel Draws plots of a group fairness metric with a second panel underneath

Description

groupmetric_2panel Draws plots of a group fairness metric with a second panel underneath

Usage

groupmetric_2panel(
  objs,
  labels,
  col = 1:length(objs),
  lty = rep(1, length(col)),
  yrange = NULL,
  ci_col = 1:length(objs),
  highlight = NULL,
  logscale = FALSE,
  mar_scale = 1,
  lpos = NULL,
  yrange_lower = NULL,
  ...
)

Arguments

objs

list of fairness objects. Each should contain sub-objects 'x', 'y' and 'ci', which specify x and y values and half-widths of confidence intervals around y.

labels

labels to use in legend

col

line colours

lty

line type, defaults to 1

yrange

limit of y axis; defaults to 0,1

ci_col

confidence envelope colours. These will be transparent.

highlight

if non-null, draw a point at a particular cutoff

logscale

if TRUE, draw with log-scale.

mar_scale

scale bottom and left margins by this amount. Also scales legend.

lpos

legend position

yrange_lower

y range for lower plot. If NULL, generates automatically

...

other parameters passed to legend()

Value

No return value, draws a figure

Examples

# See vignette