Interpret a questionnaire score

Returns a clinical interpretation for a given score on a given questionnaire, matching the score bands used in the ScoreMe app.

Usage

interpret_score(id, score, instruments = NULL)

Arguments

id

Character. Questionnaire identifier.

score

Numeric score (or named list for composite instruments).

instruments

An optional named list of additional registry entries from load_instrument() or load_instrument_dir().

Value

A list with elements label, color (hex), and description.

Examples

interpret_score("ess", 12)
#> $label
#> [1] "Excessive"
#> 
#> $color
#> [1] "#EA580C"
#> 
#> $description
#> [1] "Excessive daytime sleepiness. Consider clinical review."
#> 
interpret_score("meq", 65)
#> $label
#> [1] "Moderate morning type"
#> 
#> $color
#> [1] "#84CC16"
#> 
#> $description
#> [1] "Moderate preference for mornings."
#>