Merge pull request #586 from OHDSI/katy__release

Katy release
OHDSI · Dec 22, 2024 · d575c52 · d575c52
2 parents 2e25a15 + 1c07529
commit d575c52
Show file tree

Hide file tree

Showing 75 changed files with 228 additions and 174 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: DataQualityDashboard
 Type: Package
 Title: Execute and View Data Quality Checks on OMOP CDM Database
-Version: 2.6.1
-Date: 2024-07-12
+Version: 2.6.2
+Date: 2024-12-22
 Authors@R: c(
   person("Katy", "Sadowski", email = "[email protected]", role = c("aut", "cre")),
   person("Clair", "Blacketer", role = c("aut")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,24 @@
+DataQualityDashboard 2.6.2
+==========================
+This release includes: 
+
+### Bugfixes
+
+- Some fields were missing a standardConceptFieldName for the sourceValueCompleteness check, causing those checks to fail with an error. The missing field names have now been added
+- Many unit plausibility checks were missing legitimate units from the list of plausible units - these have now been updated
+- Sample results files in the shinyApps folder which had been causing issues for some users in rendering the Shiny app have now been removed
+- The fkDomain check has been disabled for the episode.episode_object_concept_id and measurement.value_as_concept_id fields, as these fields have multiple acceptable domains. The check can only currently support a single accepted domain
+- The withinVisitDates check was previously incorrectly categorized as a Conformance check; it has been recategorized as Plausibility
+
+### New executeDqChecks Parameter
+
+There is now a parameter, `checkSeverity`, which can be used to limit the execution of DQD to `fatal`, `convention`, and/or `characterization` checks.  Fatal checks are checks that should never fail, under any circumstance, as they relate to the relational integrity of the CDM.  Convention checks are checks on critical OMOP CDM conventions for which failures should be resolved whenever possible; however, some level of failure is unavoidable (i.e., standard concept mapping for source concepts with no suitable standard concept).  Characterization checks provide users with an understanding of the quality of the underlying data and generally will need their thresholds modified to match expectations of the source.
+
+### Documentation
+
+- We added 2 more check documentation pages - all DQ checks now have documentation!  Check out the newly added pages [here](https://ohdsi.github.io/DataQualityDashboard/articles/checkIndex.html) and please reach out with feedback as we continue improving our documentation!
+- We fixed a bug in the exclude checks sample code in CodeToRun.R
+
 DataQualityDashboard 2.6.1
 ==========================
 This release includes: 
@@ -47,7 +68,7 @@ The 3 temporal plausibilty checks are intended to **replace** `plausibleTemporal
 For more information on the new checks, please check the [Check Type Definitions](https://ohdsi.github.io/DataQualityDashboard/articles/CheckTypeDescriptions.html) documentation page.  If you'd like to disable the deprecated checks, please see the suggested check exclusion workflow in our Getting Started code [here](https://ohdsi.github.io/DataQualityDashboard/articles/DataQualityDashboard.html).
 
 ### Check Updates
-- The number of measurements checked in `plausibleUnitConceptIds` has been reduced, and the lists of plausible units for those measurements have been re-reviewed and updated for accuracy.  This change is intended to improve performance and reliablility of this check.  Please file an issue if you would like to contribute additional measurements + plausible units to be checked in the future
+- The number of measurements checked in `plausibleUnitConceptIds` has been reduced, and the lists of plausible units for those measurements have been re-reviewed and updated for accuracy.  This change is intended to improve performance and reliability of this check.  Please file an issue if you would like to contribute additional measurements + plausible units to be checked in the future
 - Some erroneous `plausibleValueLow` thresholds have been corrected to prevent false positive failures from occurring
 
 ### New Documentation

diff --git a/R/executeDqChecks.R b/R/executeDqChecks.R
@@ -35,7 +35,7 @@
 #' @param writeToCsv                Boolean to indicate if the check results will be written to a csv file. Default is FALSE
 #' @param csvFile                   (OPTIONAL) CSV file to write results
 #' @param checkLevels               Choose which DQ check levels to execute. Default is all 3 (TABLE, FIELD, CONCEPT)
-#' @param checkSeverity             Choose which DQ check severity levels to execute. Default is all 3 (fatal, convention, characterization) 
+#' @param checkSeverity             Choose which DQ check severity levels to execute. Default is all 3 (fatal, convention, characterization)
 #' @param checkNames                (OPTIONAL) Choose which check names to execute. Names can be found in inst/csv/OMOP_CDM_v[cdmVersion]_Check_Descriptions.csv. Note that "cdmTable", "cdmField" and "measureValueCompleteness" are always executed.
 #' @param cohortDefinitionId        The cohort definition id for the cohort you wish to run the DQD on. The package assumes a standard OHDSI cohort table
 #'                                  with the fields cohort_definition_id and subject_id.
@@ -117,9 +117,11 @@ executeDqChecks <- function(connectionDetails,
          You passed in ', paste(checkSeverity, collapse = ", "))
   }
 
-  stopifnot(is.null(checkNames) | is.character(checkNames), 
-            is.character(checkSeverity),
-            is.null(tablesToExclude) | is.character(tablesToExclude))
+  stopifnot(
+    is.null(checkNames) | is.character(checkNames),
+    is.character(checkSeverity),
+    is.null(tablesToExclude) | is.character(tablesToExclude)
+  )
   stopifnot(is.character(cdmVersion))
 
   # Warning if check names for determining NA is missing
@@ -250,7 +252,7 @@ executeDqChecks <- function(connectionDetails,
   })]
 
   checkDescriptionsDf <- checkDescriptionsDf[checkDescriptionsDf$checkLevel %in% checkLevels &
-    checkDescriptionsDf$severity %in% checkSeverity &                                               
+    checkDescriptionsDf$severity %in% checkSeverity &
     checkDescriptionsDf$evaluationFilter != "" &
     checkDescriptionsDf$sqlFile != "" &
     checkDescriptionsDf$checkName %in% checksToInclude, ]

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/articles/AddNewCheck.html b/docs/articles/AddNewCheck.html
diff --git a/docs/articles/CheckStatusDefinitions.html b/docs/articles/CheckStatusDefinitions.html
diff --git a/docs/articles/CheckTypeDescriptions.html b/docs/articles/CheckTypeDescriptions.html
diff --git a/docs/articles/DataQualityDashboard.html b/docs/articles/DataQualityDashboard.html
diff --git a/docs/articles/DqdForCohorts.html b/docs/articles/DqdForCohorts.html
diff --git a/docs/articles/SqlOnly.html b/docs/articles/SqlOnly.html
diff --git a/docs/articles/Thresholds.html b/docs/articles/Thresholds.html