R/summarizeResults.R

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

# Copyright 2026 Observational Health Data Sciences and Informatics
#
# This file is part of DataQualityDashboard
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#' Internal function to summarize the results of the DQD run.
#'
#' @param checkResults              A dataframe containing the results of the checks after running against the database
#'
#' @return A list containing summary statistics of the check results
#'
#' @keywords internal
#'

.summarizeResults <- function(checkResults) {
  countTotal <- nrow(checkResults)

  countThresholdFailed <- nrow(checkResults[checkResults$failed == 1 &
    is.na(checkResults$error), ])

  countErrorFailed <- nrow(checkResults[!is.na(checkResults$error), ])

  countOverallFailed <- nrow(checkResults[checkResults$failed == 1, ])

  countPassed <- countTotal - countOverallFailed

  countTotalPlausibility <- nrow(checkResults[checkResults$category == "Plausibility", ])

  countTotalConformance <- nrow(checkResults[checkResults$category == "Conformance", ])

  countTotalCompleteness <- nrow(checkResults[checkResults$category == "Completeness", ])

  countFailedPlausibility <- nrow(checkResults[checkResults$category == "Plausibility" &
    checkResults$failed == 1, ])

  countFailedConformance <- nrow(checkResults[checkResults$category == "Conformance" &
    checkResults$failed == 1, ])

  countFailedCompleteness <- nrow(checkResults[checkResults$category == "Completeness" &
    checkResults$failed == 1, ])

  countPassedPlausibility <- nrow(checkResults[checkResults$category == "Plausibility" &
    checkResults$passed == 1, ])

  countPassedConformance <- nrow(checkResults[checkResults$category == "Conformance" &
    checkResults$passed == 1, ])

  countPassedCompleteness <- nrow(checkResults[checkResults$category == "Completeness" &
    checkResults$passed == 1, ])

  list(
    countTotal = countTotal,
    countPassed = countPassed,
    countErrorFailed = countErrorFailed,
    countThresholdFailed = countThresholdFailed,
    countOverallFailed = countOverallFailed,
    percentPassed = round(countPassed / (countPassed + countOverallFailed) * 100, 2),
    percentFailed = round(countOverallFailed / (countPassed + countOverallFailed) * 100, 2),
    countTotalPlausibility = countTotalPlausibility,
    countTotalConformance = countTotalConformance,
    countTotalCompleteness = countTotalCompleteness,
    countFailedPlausibility = countFailedPlausibility,
    countFailedConformance = countFailedConformance,
    countFailedCompleteness = countFailedCompleteness,
    countPassedPlausibility = countPassedPlausibility,
    countPassedConformance = countPassedConformance,
    countPassedCompleteness = countPassedCompleteness
  )
}