Validate Data Against a 'data-dict.yaml' Data Dictionary

A data dictionary describes a collection of related tables: their columns, types, constraints, relationships, and glossary. Validate a dataset against its dictionary and read the findings as an HTML report. Reference: < https://data-dict.tidyverse.org>.

datadict

datadict validates a dataset against a data-dict.yaml data dictionary, and reports the findings as a self-contained HTML report.

Installation

# Install the released version from CRAN
install.packages("testthat")

# Or the development version from GitHub:
# install.packages("pak")
pak::pak("r-lib/testthat")

Example

Point dd_validate_data() at a directory holding a data-dict.yaml file and the parquet files it describes:

library(datadict)

dd_validate_data("inst/data")

This writes an HTML report and opens it in a browser. A dataset that fails validation is not an R error: the report is the point, so check the returned status to see whether the run passed.