DataQualityDashboard icon indicating copy to clipboard operation
DataQualityDashboard copied to clipboard

Custom check in seprate package.

Open galachad opened this issue 2 years ago • 5 comments

  • Add possibility build the DataQuality package on the top of DataQualityDashboard.

DataQualityDashboard

Why it's helpful:

  • Run custom checks on specific omop dataset.
  • Write custom sql checks.
  • Do not need to edit DataQualityDashboard when adding/removing checks.

Example useage:

DataQualityDashboard::executeDqChecks(connectionDetails = connectionDetails, 
                                    cdmDatabaseSchema = cdmDatabaseSchema, 
                                    resultsDatabaseSchema = resultsDatabaseSchema,
                                    cdmSourceName = "IBM_CCAE_cohort_123",
                                    cohortDefinitionId = 123,
                                    cohortDatabaseSchema = "IBM_CCAE.results"
                                    numThreads = numThreads,
                                    sqlOnly = sqlOnly, 
                                    outputFolder = outputFolder, 
                                    verboseMode = verboseMode,
                                    writeToTable = writeToTable,
                                    writeTableName = "dqdashboard_results_123",
                                    checkLevels = checkLevels,
                                    tablesToExclude = tablesToExclude,
                                    checkNames = checkNames,
                                    cdmVersion = "Custom5.4",
                                    systemFileNamespace = "PackageWithDefinedChecks")
                                    
# PackageWithDefinedChecks needs to contains the `Custom5.4` csv check files. 

galachad avatar Nov 07 '22 08:11 galachad

Hi @clairblacketer, do you have chance to take a look on this pr? Thanks

galachad avatar Nov 28 '22 07:11 galachad

Hi @galachad, thanks very much for the submission! This is a nice & tidy solution to a challenge I'm sure many DQD users run into. We will discuss this in our next DQD team meeting and I'll get back to you about how we'd like to proceed.

In the meantime, just to confirm my understanding of the approach here:

  • SQL files for new custom checks are stored in the separate "PackageWithChecks", while the SQL files for the standard DQD checks stay in DataQualityDashboard
  • The packageName column in the Check Description files tells DQD where to look for the SQL file for a given check
  • Full copies of the check description & threshold files, containing descriptions of checks & thresholds for both the standard DQD checks and the custom checks, are stored in "PackageWithChecks"

katy-sadowski avatar Nov 30 '22 16:11 katy-sadowski

Hi @katy-sadowski, Yes, mainly that was the idea. I tested this approach in one of the project I'm working on.

Is it possible to join to DQD community and your meetings?

galachad avatar Dec 05 '22 12:12 galachad

Is it possible to join to DQD community and your meetings?

Sure thing! Our next meeting is planned for next Thursday at 10am Eastern US time, and you can sign up to join here: https://forms.office.com/Pages/ResponsePage.aspx?id=lAAPoyCRq0q6TOVQkCOy1ZyG6Ud_r2tKuS0HcGnqiQZUOVJFUzBFWE1aSVlLN0ozR01MUVQ4T0RGNyQlQCN0PWcu

katy-sadowski avatar Dec 05 '22 15:12 katy-sadowski

Hi again @galachad - @clairblacketer just added you to the DQD Working Group in Microsoft Teams. We'd love to have you join an upcoming meeting to present your PR and talk a bit about how you're using this feature at your institution.

katy-sadowski avatar Dec 15 '22 16:12 katy-sadowski