data.checker (version 2.0.0)

check_and_export: Validate data against a schema and output results

Description

This function validates data against a given schema, performs checks, and exports the validation results to a specified file in a given format.

Usage

check_and_export(
  data,
  schema,
  file,
  format,
  hard_check = FALSE,
  backseries = NULL,
  name = deparse(substitute(data))
)

Value

The exported validation results.

Arguments

data

The data to be validated.

schema

The schema to validate against.

file

The file path where the validation results will be exported.

format

The format in which the validation results will be exported.

hard_check

logical. Optional - FALSE by default. If TRUE, raises an error if there are any failed checks. Otherwise, raises a warning.

backseries

A previous version of the data to check against (optional).

name

validator name - defaults to the name of the dataframe object supplied to "data" (Optional). Must be a single character string.

Examples

# create schema
schema <- list(
  check_duplicates = FALSE,
  check_completeness = FALSE,
  columns = list(
    age = list(type = "double", optional = FALSE),
    sex = list(type = "character", optional = FALSE)
  )
)

# create dataframe
df <- data.frame(
  age = c(10, 11, 13, 15, 22, 34, 80),
  sex = c("M", "F", "M", "F", "M", "F", "M")
)

# validate and export log
check_and_export(
  data = df,
  schema = schema,
  file = paste0(tempdir(),"\\validation_results_example.html"),
  format = "html",
  hard_check = TRUE
)
# \dontshow{
file.remove(paste0(tempdir(),"\\validation_results_example.html"))
# }