pull_survey: Retrieve a survey from a survey list

In retroharmonize: Ex Post Survey Data Harmonization

Retrieve a survey from a survey list

Description

'pull_survey()' retrieves a survey object from a list created with [read_surveys()].

Surveys can be selected using:

- the survey identifier stored in the '"id"' attribute, or - the original source file name stored in the '"filename"' attribute.

Usage

pull_survey(survey_list, id = NULL, filename = NULL)

Arguments

survey_list	A list of 'survey' objects.
id	Optional survey identifier.
filename	Optional source file name.

Details

Extract a single 'survey' object from a list of surveys using either its survey identifier or source file name.

Either 'id' or 'filename' must be supplied.

The function throws an error if:

- neither argument is provided; - the requested survey cannot be found; - or multiple surveys match the query.

Value

A single 'survey' object.

See Also

[read_surveys()]

Other import functions: harmonize_survey_variables(), read_csv(), read_dta(), read_rds(), read_spss(), read_surveys()

Examples

examples_dir <- system.file(
  "examples",
  package = "retroharmonize"
)

survey_files <- dir(
  examples_dir,
  pattern = "\\.rds$"
)

example_surveys <- read_surveys(
  file.path(examples_dir, survey_files)
)

pull_survey(
  example_surveys,
  id = "ZA5913"
)

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