View source: R/civic_scorecard.R
| civic_audit | R Documentation |
Produces a structured JSON audit record for any 'civic_model': provenance metadata (data hash, seed, analyst, timestamp), performance metrics, equity summary, and DataCitizen-Pro annotations.
civic_audit(
object,
metrics = NULL,
fairness = NULL,
notes = NULL,
analyst = NULL,
path = NULL
)
object |
A 'civic_model'. |
metrics |
Named numeric vector from [civic_metrics()] (optional). |
fairness |
A 'civic_fairness' from [civic_fairness()] (optional). |
notes |
Character analyst notes (optional). |
analyst |
Character analyst name (optional). |
path |
File path to write the JSON (optional). |
Invisibly, the JSON character string.
m <- civic_fit(voted ~ age + education, civic_voting)
trail <- civic_audit(m, analyst = "O. O. Awe", notes = "Baseline")
cat(trail)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.