report_datasheet: Create a Datasheet for Documenting a Dataset

In mlr3fairness: Fairness Auditing and Debiasing for 'mlr3'

Create a Datasheet for Documenting a Dataset

Description

Creates a new rmarkdown template with a skeleton questionnaire for dataset documentation. Uses the awesome markdown template created by Chris Garbin from Github.

Usage

report_datasheet(filename = "datasheet.Rmd", edit = FALSE, build = FALSE)

Arguments

filename	(character(1)) File path or name for new file that should be created.
edit	(logical(1)) TRUE to edit the template immediately.
build	(logical(1)) Should the report be built after creation? Initialized to FALSE.

Value

Invisibly returns the path to the newly created file(s).

References

Gebru, Timnit, Morgenstern, Jamie, Vecchione, Briana, Vaughan, Wortman J, Wallach, Hanna, III D, Hal, Crawford, Kate (2018). “Datasheets for datasets.” arXiv preprint arXiv:1803.09010.

See Also

Other fairness_reports: report_fairness(), report_modelcard()

Examples

  report_file = tempfile()
  report_datasheet(report_file)

mlr3fairness documentation built on May 31, 2023, 7:22 p.m.