Report on Measure Database Quality

Analyses a measures database and reports on completeness and consistency.

Usage

boilerplate_measures_report(db, measure_names = NULL, return_report = FALSE)

Arguments

db

List. Measures database to analyse.

measure_names

Character vector. Specific measures to analyse. If NULL, analyses all.

return_report

Logical. If TRUE, returns a data frame report. Default is FALSE.

Value

If return_report is TRUE, returns a data frame with quality metrics.

Examples

# \donttest{
# Create temporary directory for example
temp_dir <- tempfile()
dir.create(temp_dir)

# Initialise and import
boilerplate_init(data_path = temp_dir, categories = "measures",
                 create_dirs = TRUE, confirm = FALSE, quiet = TRUE)
unified_db <- boilerplate_import(data_path = temp_dir, quiet = TRUE)

# Get a quality report
report <- boilerplate_measures_report(unified_db$measures, return_report = TRUE)
#> 
#> === Measures Database Quality Report ===
#> Total measures: 1
#> Complete descriptions: 0 (0.0%)
#> With references: 0 (0.0%)
#> With items: 0 (0.0%)
#> With wave info: 0 (0.0%)
#> Already standardised: 0 (0.0%)

# Just print summary
boilerplate_measures_report(unified_db$measures)
#> 
#> === Measures Database Quality Report ===
#> Total measures: 1
#> Complete descriptions: 0 (0.0%)
#> With references: 0 (0.0%)
#> With items: 0 (0.0%)
#> With wave info: 0 (0.0%)
#> Already standardised: 0 (0.0%)

# Clean up
unlink(temp_dir, recursive = TRUE)
# }