Construct a city profile (column map onto the canonical audit schema)

Each *_col argument names the column, in that city's own export, that carries the corresponding canonical field. risk_col and outcome_col may be NULL when a city only supplies one side (e.g. risk scores but no realised- outcome feed); the missing side must then be supplied separately to the audit.

Usage

morie_fairness_city_profile(
  name,
  area_col,
  risk_col = NULL,
  outcome_col = NULL,
  population_col = NULL,
  group_col = NULL,
  notes = ""
)

Arguments

name

Character identifier used with morie_fairness_get_city.

area_col

Column holding the area / district / precinct identifier. Required.

risk_col, outcome_col, population_col, group_col

Optional columns for predicted risk, realised-outcome count, area population, and protected attribute.

notes

Free-text provenance or caveats, surfaced to the user.

Value

A list of class morie_city_profile.

Examples

p <- morie_fairness_city_profile(
  "chicago", area_col = "community_area",
  risk_col = "rti", group_col = "majority_race"
)
p$name
#> [1] "chicago"