checkResult: Create object of class checkResult

In dataMaid: A Suite of Checks for Identification of Potential Errors in a Data Frame as Part of the Data Screening Process

Create object of class checkResult

Description

Convert a list resulting from the checks performed in a checkFunction into a checkResult object, thereby supplying it with a print() method.

Usage

checkResult(ls)

Arguments

ls

A list with entries $problem (logical indicating whether a problem was found), $message (a character string containing a message describing the problem) and $problemValues (the values in the checked variables that were marked as problematic). Note that $message and $problemValues can be left empty (i.e. "" and NULL, respectively), if they are not relevant.

Value

A S3 object of class checkResult, identical to the inputted list, ls, except for its class attribute.

See Also

checkFunction

dataMaid documentation built on April 14, 2025, 1:09 a.m.