dot-runCheck: Internal function to run and process each data quality check.

In DataQualityDashboard: Execute and View Data Quality Checks on OMOP CDM Database

Internal function to run and process each data quality check.

Description

Internal function to run and process each data quality check.

Usage

.runCheck(
  checkDescription,
  tableChecks,
  fieldChecks,
  conceptChecks,
  connectionDetails,
  connection,
  cdmDatabaseSchema,
  vocabDatabaseSchema,
  resultsDatabaseSchema,
  writeTableName,
  cohortDatabaseSchema,
  cohortTableName,
  cohortDefinitionId,
  outputFolder,
  sqlOnlyUnionCount,
  sqlOnlyIncrementalInsert,
  sqlOnly
)

Arguments

checkDescription	The description of the data quality check
tableChecks	A dataframe containing the table checks
fieldChecks	A dataframe containing the field checks
conceptChecks	A dataframe containing the concept checks
connectionDetails	A connectionDetails object for connecting to the CDM database
connection	A connection for connecting to the CDM database using the DatabaseConnector::connect(connectionDetails) function.
cdmDatabaseSchema	The fully qualified database name of the CDM schema
vocabDatabaseSchema	The fully qualified database name of the vocabulary schema (default is to set it as the cdmDatabaseSchema)
resultsDatabaseSchema	The fully qualified database name of the results schema
writeTableName	The table tor write DQD results to. Used when sqlOnly or writeToTable is True.
cohortDatabaseSchema	The schema where the cohort table is located.
cohortTableName	The name of the cohort table.
cohortDefinitionId	The cohort definition id for the cohort you wish to run the DQD on. The package assumes a standard OHDSI cohort table called 'Cohort'
outputFolder	The folder to output logs and SQL files to
sqlOnlyUnionCount	(OPTIONAL) How many SQL commands to union before inserting them into output table (speeds processing when queries done in parallel). Default is 1.
sqlOnlyIncrementalInsert	(OPTIONAL) Boolean to determine whether insert check results and associated metadata into output table. Default is FALSE (for backwards compatability to <= v2.2.0)
sqlOnly	Should the SQLs be executed (FALSE) or just returned (TRUE)?

Value

A dataframe containing the check results or SQL queries (NULL if sqlOnlyIncrementalInsert is TRUE)

DataQualityDashboard documentation built on Jan. 29, 2026, 1:07 a.m.