Create a survey data frame — survey • retroharmonize

Store the data of a survey in a tibble (data frame) with a unique survey identifier, import filename, and optional document object identifier.

Usage

survey(
  object = data.frame(),
  id = character(),
  filename = character(),
  doi = character()
)

is.survey(object)

# S3 method for survey
summary(object, ...)

Arguments

object: A tibble or data frame that contains the survey data.
id: A mandatory identifier for the survey.
filename: The import file name.
doi: Optional document object identifier (doi), can be omitted.
...: Arguments passed to summary method.

Value

A tibble with id, filename, doimetadata information.

Details

Whilst you can create a survey object with this helper function, it is most likely that you will receive it with an importing function, i.e. read_rds, read_spss read_dta, read_csv or their common wrapper read_survey.

Examples

example_survey <- survey( 
  object =data.frame ( 
    rowid = 1:6,
    observations = runif(6)), 
  id = 'example', 
  filename = "no_file"
)