Achilles (version 1.5)

achillesHeel: execution of data quality rules

Description

achillesHeel executes data quality rules (or checks) on pre-computed analyses (or measures).

Usage

achillesHeel(connectionDetails, cdmDatabaseSchema,
  oracleTempSchema = cdmDatabaseSchema,
  resultsDatabaseSchema = cdmDatabaseSchema, cdmVersion = "5",
  vocabDatabaseSchema = cdmDatabaseSchema)

Arguments

connectionDetails

An R object of type ConnectionDetail (details for the function that contains server info, database type, optionally username/password, port)

cdmDatabaseSchema

string name of database schema that contains OMOP CDM. On SQL Server, this should specifiy both the database and the schema, so for example 'cdm_instance.dbo'.

oracleTempSchema

For Oracle only: the name of the database schema where you want all temporary tables to be managed. Requires create/insert permissions to this database.

resultsDatabaseSchema

string name of database schema that we can write results to. Default is cdmDatabaseSchema. On SQL Server, this should specifiy both the database and the schema, so for example 'results.dbo'.

cdmVersion

Define the OMOP CDM version used: currently support "4" and "5". Default = "4"

vocabDatabaseSchema

string name of database schema that contains OMOP Vocabulary. Default is cdmDatabaseSchema. On SQL Server, this should specifiy both the database and the schema, so for example 'results.dbo'.

Value

nothing is returned

Details

achillesHeel contains number of rules (authored in SQL) that are executed againts achilles results tables.

Examples

# NOT RUN {
  connectionDetails <- DatabaseConnector::createConnectionDetails(dbms="sql server", server="myserver")
  achillesHeel <- achilles(connectionDetails, cdmDatabaseSchema="mycdm", resultsDatabaseSchema="scratch", vocabDatabaseSchema="vocabulary")
# }