Function reference • dbGaPCheckup

Primary Function

Primary function needed to run dbGaPCheckup.

check_report(): Check Report

Reporting and Awareness Functions

Reporting functions to generate textual and graphical reports of the data.

create_report(): Create Report

create_awareness_report(): Create Awareness Report

missingness_summary(): Missingness Summary

value_missing_table(): Values Missing Table Awareness Function

dictionary_search(): Data Dictionary Search

Quick Fix Functions

Functions that implement “quick fixes” when scalable errors are identified.

add_missing_fields(): Add Missing Fields

name_correct(): Name Correction Utility Function

reorder_dictionary(): Reorder Data Dictionary Utility Function

reorder_data(): Reorder Data Set Utility Function

id_first_data(): Relocate SUBJECT_ID to First Column of Data Set

id_first_dict(): Relocate SUBJECT_ID to First Column of Data Dictionary

Post-Cleaning Functions

Functions designed to be used on the clean data set and data dictionary.

label_data(): Label the data

Check Functions

dbGaPCheckup check functions (most of which are embeeded in check_report).

NA_check(): Missing Value (NA) Check

complete_check(): Complete Check

decimal_check(): Decimal Check

description_check(): Description Check

dimension_check(): Dimension Check

field_check(): Field Check

id_check(): ID Check

int_check(): Integer Check Base Function

integer_check(): Integer Check

minmax_check(): Mimimum and Maximum Values Check

misc_format_check(): Miscellaneous Format Check

missing_value_check(): Missing Value Check

name_check(): Name Check

pkg_field_check(): Package Required Field Check

row_check(): Row Check

short_field_check(): Truncated Field Check

type_check(): Type Check

values_check(): Values Check

Pre-check Functions

Pre-checks embedded in several dbGaPCheckup check functions.

NA_precheck(): Min Max Required Pre-checks

mm_precheck(): Min Max Required Pre-checks

mv_precheck(): Missing Values Required Pre-checks

name_precheck(): Name Pre-checks

short_precheck(): Truncated Pre-check

super_short_precheck(): Very Truncated Pre-check

values_precheck(): Values Pre-Check

Misc Utility Functions

Miscellaneous utility functions.

dat_function(): Data Utility Function

dat_function_selected(): Data Selected Utility Function

eval_function(): Evaluation Utility Function

dup_values(): Duplicate Values Function

value_meaning_table(): Value-Meaning Table

Example Data Sets

Variety of example data sets for illustrating function utility.

ExampleA: ExampleA

ExampleB: ExampleB

ExampleC: ExampleC

ExampleD: ExampleD

ExampleE: ExampleE

ExampleF: ExampleF

ExampleG: ExampleG

ExampleH: ExampleH

ExampleI: ExampleI

ExampleJ: ExampleJ

ExampleK: ExampleK

ExampleL: ExampleL

ExampleM: ExampleM

ExampleN: ExampleN

ExampleO: ExampleO

ExampleP: ExampleP

ExampleQ: ExampleQ

ExampleR: ExampleR

ExampleS: ExampleS

ExampleA: DD.dict.A

ExampleB: DD.dict.B

ExampleC: DD.dict.C

ExampleD: DD.dict.D

ExampleE: DD.dict.E

ExampleF: DD.dict.F

ExampleG: DD.dict.G

ExampleH: DD.dict.H

ExampleI: DD.dict.I

ExampleJ: DD.dict.J

ExampleK: DD.dict.K

ExampleL: DD.dict.L

ExampleM: DD.dict.M

ExampleN: DD.dict.N

ExampleQ: DD.dict.Q

ExampleR: DD.dict.R

ExampleS: DD.dict.S

ExampleA: DS.data.A

ExampleB: DS.data.B

ExampleC: DS.data.C

ExampleD: DS.data.D

ExampleE: DS.data.E

ExampleF: DS.data.F

ExampleG: DS.data.G

ExampleH: DS.data.H

ExampleI: DS.data.I

ExampleJ: DS.data.J

ExampleK: DS.data.K

ExampleL: DS.data.L

ExampleM: DS.data.M

ExampleN: DS.data.N

ExampleO: DS.data.O

ExampleP: DS.data.P

ExampleQ: DS.data.Q

ExampleR: DS.data.R

ExampleS: DS.data.S