proof: Proof tabular data

Description Usage Arguments Examples

View source: R/proof.R

Description

Specify a tibble or dataframe and perform automated data proofing tests.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
proof(
  data,
  suite = "all",
  tests = "none",
  out = FALSE,
  out_format = "json",
  summary = FALSE,
  verbose = FALSE,
  exclude = FALSE
)

Arguments

data

Tibble or dataframe to test.

suite

Which suite of tests do you want to perform? Defaults to "all", other options include "core", "info", "stats" and "geo".

tests

Which individual tests do you want to perform?

out

Export the results to a json file. Specify a path to export.

out_format

Choose between "json" (default) and "json-pretty".

summary

Exclude tests that passed.

verbose

Include descriptions about each column.

Examples

1
2
3
4
5
6
7
proof(mtcars)

proof(iris,
      tests = c("duplicate rows", "empty cells"),
      out = "results.json", out_format = "json-pretty")

proof(PlantGrowth, suite = "stats", verbose = TRUE)

dataproofer/dataproofr documentation built on Dec. 19, 2021, 9 p.m.