setChecks: Set check arguments for makeDataReport

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

Description

This function is a tool for easily specifying the checks argument of makeDataReport. Note that all available check function options can be inspected by calling allCheckFunctions().

Usage

setChecks(
  character = defaultCharacterChecks(),
  factor = defaultFactorChecks(),
  labelled = defaultLabelledChecks(),
  haven_labelled = defaultHavenlabelledChecks(),
  numeric = defaultNumericChecks(),
  integer = defaultIntegerChecks(),
  logical = defaultLogicalChecks(),
  Date = defaultDateChecks(),
  all = NULL
)

Arguments

character	A character vector of function names to be used as checks for character variables. The default options are available by calling defaultCharacterChecks().
factor	A character vector of function names to be used as checks for factor variables. The default options are available by calling defaultFactorChecks().
labelled	A character vector of function names to be used as checks for labelled variables. The default options are available by calling defaultLabelledChecks().
haven_labelled	A character vector of function names to be used as checks for haven_labelled variables. The default options are available by calling defaultHavenlabelledChecks().
numeric	A character vector of function names to be used as checks for numeric variables. The default options are available by calling defaultNumericChecks().
integer	A character vector of function names to be used as checks for integer variables. The default options are available by calling defaultIntegerChecks().
logical	A character vector of function names to be used as checks for logical variables. The default options are available by calling defaultLogicalChecks().
Date	A character vector of function names to be used as checks for Date variables. The default options are available by calling defaultDateChecks().
all	A character vector of function names to be used as checks for all variables. Note that this overrules the choices made for specific variable types by using the other arguments.

Value

A list with one entry for each data class supported by makeDataReport. Each entry then contains a character vector of function names that are to be called as checks for that variable type.

See Also

makeDataReport, allCheckFunctions, defaultCharacterChecks, defaultFactorChecks, defaultLabelledChecks, defaultHavenlabelledChecks, defaultNumericChecks, defaultIntegerChecks, defaultLogicalChecks, defaultDateChecks

Examples

#Only identify missing values for characters, logicals and labelled variables:
  setChecks(character = "identifyMissing", factor = "identifyMissing", 
     labelled = "identifyMissing")
     
#Used in a call to makeDataReport():
## Not run: 
data(toyData)
makeDataReport(toyData, checks = setChecks(character = "identifyMissing", 
   factor = "identifyMissing", labelled = "identifyMissing"), replace = TRUE)

## End(Not run)
     

dataMaid documentation built on Oct. 8, 2021, 9:08 a.m.