description_check {dbGaPCheckup}

R Documentation

Description Check

Description

This function checks that there is a unique description for every variable in the data dictionary (VARDESC column).

Usage

description_check(DD.dict, verbose = TRUE)

Arguments

DD.dict	Data dictionary.
verbose	When TRUE, the function prints the Message out, as well as a list of the variables that are missing a VARDESC or have a duplicated VARDESC.

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 the variables with missing or duplicated descriptions).

Examples

# Example 1: Fail check 
data(ExampleG)
description_check(DD.dict.G)
print(description_check(DD.dict.G, verbose=FALSE))

# Example 2: Pass check
data(ExampleA)
description_check(DD.dict.A)
print(description_check(DD.dict.A, verbose=FALSE))

---