Skip to contents

Label HiTOP-BR Columns with Semantic Descriptions

Source: R/label_hitopbr.R
label_hitopbr.Rd

Add literal item text or clean scale names as attributes to data frame columns for the HiTOP Brief Report (HiTOP-BR), making them readable by data viewers and reporting packages.

Usage

label_hitopbr(data, target = c("items", "scales"), prefix = "HBR_")

Arguments

data

A data frame containing HiTOP-BR items or scales.

target

A string specifying what to label: "items" to label raw item columns with questionnaire text, or "scales" to label computed scale columns.

prefix

An optional string specifying the prefix used on the column names. (default = "HBR_")

Value

A data frame with labeled columns.

Examples

# Attach item text as a `label` attribute to the raw item columns
labeled <- label_hitopbr(sim_hitopbr, target = "items", prefix = "hitopbr_")
attr(labeled$hitopbr_1, "label")
#> [1] "I found it easy to deceive others."