scrutiny (version 0.5.0)

audit-special: Summarize output of sequence mappers and total-n mappers

Description

audit_seq() and audit_total_n() summarize the results of functions that end on _seq and _total_n, respectively.

See below for a record of such functions. Go to the documentation of any of them to learn about the way its output is processed by audit_seq() or audit_total_n().

Usage

audit_seq(data)
audit_total_n(data)

Value

A tibble (data frame) with test summary statistics.

Arguments

data

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

Before <code>audit_seq()</code>

Function	Class
grim_map_seq()	"scr_grim_map_seq"
grimmer_map_seq()	"scr_grimmer_map_seq"
debit_map_seq()	"scr_debit_map_seq"

Before <code>audit_total_n()</code>

Function	Class
grim_map_total_n()	"scr_grim_map_total_n"
grimmer_map_total_n()	"scr_grimmer_map_total_n"
debit_map_total_n()	"scr_debit_map_total_n"

Details

All functions named below that end on _seq were made by function_map_seq(). All that end on _total_n were made by function_map_total_n().

Examples

# For GRIM-testing with dispersed inputs:
out <- pigs1 %>%
  grim_map_seq() %>%
  audit_seq()
out

# Follow up on `audit_seq()` or
# `audit_total_n()` with `audit()`:
audit(out)