metadata_survey_create: Create variable-level metadata from a survey dataset

In retroharmonize: Ex Post Survey Data Harmonization

Create variable-level metadata from a survey dataset

Description

Extract variable-level metadata from a survey dataset and return the result as a nested data frame.

Usage

metadata_survey_create(survey)

Arguments

survey

A survey object of class [survey()]. Survey objects are typically created with: [read_rds()] [read_spss()] [read_dta()] [read_csv()] [read_survey()] Survey objects can also be created manually from a data frame with [survey()].

Details

The metadata table contains:

• variable names and labels,

• imported storage classes,

• value labels,

• user-defined missing values,

• missing value ranges,

• and summary counts of labelled categories.

For multiple surveys, use [metadata_create()], which applies 'metadata_survey_create()' across a list of surveys or survey files.

Value

A nested data frame containing:

filename

Original survey file name.

id

Survey identifier.

var_name_orig

Original variable name.

class_orig

Imported storage class.

var_label_orig

Original variable label.

labels

List column of value labels.

valid_labels

List column of non-missing value labels.

na_labels

List column of user-defined missing labels.

na_range

List column containing user-defined missing ranges.

n_labels

Number of labelled categories.

n_valid_labels

Number of non-missing categories.

n_na_labels

Number of missing categories.

See Also

[metadata_create()], [create_variable_catalog()]

Other metadata functions: create_codebook(), is.crosswalk_table(), metadata_create()

Examples

metadata_survey_create(
  survey = read_rds(
    system.file(
      "examples",
      "ZA7576.rds",
      package = "retroharmonize"
    )
  )
)

retroharmonize documentation built on May 21, 2026, 9:06 a.m.