write_doc_audit_total_n {scrutiny}

Documentation template for audit_total_n()

Description

write_doc_audit_total_n() creates a roxygen2 block section to be inserted into the documentation of functions created with function_map_total_n(). The section informs users about the ways in which audit_seq() summarizes the results of the manufactured ⁠*_map_total_n()⁠ function.

Copy the output from your console and paste it into the roxygen2 block of your ⁠*_map_total_n()⁠ function. To preserve the bullet-point structure when indenting roxygen2 comments with Ctrl+Shift+/, leave empty lines between the pasted output and the rest of the block.

Usage

write_doc_audit_total_n(key_args, name_test)

Arguments

key_args

String vector with the names of the key columns that are tested for consistency by the ⁠*_map_seq()⁠ function. (These are the original variable names, without "1" and "2" suffixes.) The values need to have the same order as in that function's output.

name_test

String (length 1). Name of the consistency test which the ⁠*_map_seq()⁠ function applies, such as "GRIM".

Value

A string vector formatted by glue::glue().

See Also

The sister function write_doc_audit_seq() and, for context, vignette("consistency-tests-in-depth").

Examples

# For GRIM and `grim_map_total_n()`:
write_doc_audit_total_n(key_args = c("x", "n"), name_test = "GRIM")

# For DEBIT and `debit_map_total_n()`:
write_doc_audit_total_n(key_args = c("x", "sd", "n"), name_test = "DEBIT")