scrutiny (version 0.5.0)

audit: Summarize scrutiny objects

Description

audit() summarizes the results of scrutiny functions like grim_map() that perform tests on data frames.

See below for a record of such functions. Go to the documentation of any of them to learn about its audit() method.

Usage

audit(data)

Value

A tibble (data frame) with test summary statistics.

Arguments

data

A data frame that inherits one of the classes named below.

Run before <code>audit()</code>

Function	Class
grim_map()	"scr_grim_map"
grimmer_map()	"scr_grimmer_map"
debit_map()	"scr_debit_map"
duplicate_count()	"scr_dup_count"
duplicate_count_colpair()	"scr_dup_count_colpair"
duplicate_tally()	"scr_dup_tally"
duplicate_detect()	"scr_dup_detect"
audit_seq()	"scr_audit_seq"
audit_total_n()	"scr_audit_total_n"

Details

audit() is an S3 generic. It looks up the (invisible) scrutiny class of a tibble returned by any function named below. You don't need to deal with the classes directly. Behind the scenes, they mediate between these functions and their associated summary statistics.

Examples

# For basic GRIM-testing:
pigs1 %>%
  grim_map() %>%
  audit()

# For duplicate detection:
pigs4 %>%
  duplicate_count() %>%
  audit()