inspectr (version 1.0.0)

two_col_check: Check a column for data fidelity using criteria related to a second column.

Description

Check a column for data fidelity using criteria related to a second column.

Usage

two_col_check(colname1, colname2, data, fun, output = FALSE, stage = NULL, ...)

Arguments

colname1

character string specifying the name of the column within your dataframe that will be the subject of the checks.

colname2

character string specifying the name of a second column to be used in the check criteria.

data

the dataframe containing the data.

fun

the check function you'd like to apply to the data.

output

logical. If FALSE, the function returns a dataframe containing only records that failed the specified check. If TRUE, invisibly prints an excel output file containing only the records that failed the specified check.

stage

An optional character string that can be used to specify the stage of the checking process in which the check is occurring. Only useful if output = TRUE. If a value is specified, a that value is prefixed to the output file; if no value is given, no stage prefix is attached.

...

arguments to be passed through to the function specified in fun

Value

col_check(output = FALSE) returns a dataframe containing only records that failed the specified check.col_check(output = TRUE) invisibly prints an excel output file containing only records that failed the specified check.

Examples

two_col_check("Var1", "Var2", dataset, less_than_equalto, output = FALSE)

two_col_check("Var2", "Var1", dataset, greater_than, output = TRUE,
   stage = "1-Reasonableness")