Access Measures from Unified Database — boilerplate

This function extracts and returns the measures portion of a unified database, optionally retrieving a specific measure by name.

Usage

boilerplate_measures(unified_db, name = NULL)

Arguments

unified_db: List. The unified boilerplate database
name: Character. Optional specific measure to retrieve

Value

List. The requested measures database or specific measure

Examples

# Create a temporary directory and initialise database
temp_dir <- tempdir()
data_path <- file.path(temp_dir, "boilerplate_measures_example", "data")

# Initialise with default measures
boilerplate_init(
  categories = "measures",
  data_path = data_path,
  create_dirs = TRUE,
  create_empty = FALSE,
  confirm = FALSE,
  quiet = TRUE
)

# Import all databases
unified_db <- boilerplate_import(data_path = data_path, quiet = TRUE)

# Get all measures
measures_db <- boilerplate_measures(unified_db)
names(measures_db)
#> [1] "anxiety"           "depression"        "alcohol_frequency"
#> [4] "life_satisfaction"

# Get a specific measure
if ("anxiety" %in% names(measures_db)) {
  anxiety_measure <- boilerplate_measures(unified_db, "anxiety")
  anxiety_measure$description
}
#> [1] "anxiety was measured using a standard anxiety scale"

# Clean up
unlink(file.path(temp_dir, "boilerplate_measures_example"), recursive = TRUE)