name_check {dbGaPCheckup} | R Documentation |
Name Check
Description
This function checks if the variable names match between the data dictionary and the data.
Usage
name_check(DD.dict, DS.data, verbose = TRUE)
Arguments
DD.dict |
Data dictionary. |
DS.data |
Data set. |
verbose |
When TRUE, the function prints the Message out, as well as a list of the non-matching variable names. |
Value
Tibble, returned invisibly, containing: (1) Time (time stamp); (2) Name (name of the function); (3) Status (Passed/Failed); (4) Message (A copy of the message the function printed out); (5) Information (Names of variables that mismatch between the data and data dictionary).
See Also
Examples
# Example 1: Fail check (name mismatch)
data(ExampleM)
name_check(DD.dict.M, DS.data.M)
DS.data_updated <- name_correct(DD.dict.M, DS.data.M)
name_check(DD.dict.M, DS.data_updated)
# Example 2: Pass check
data(ExampleA)
name_check(DD.dict.A, DS.data.A)
print(name_check(DD.dict.A, DS.data.A, verbose=FALSE))
[Package dbGaPCheckup version 1.1.0 Index]