read_survey function

Read a CSV file exported from Qualtrics

Read a CSV file exported from Qualtrics

Reads comma separated CSV files generated by Qualtrics software. The second line containing the variable labels is imported. Repetitive introductions to matrix questions are automatically removed. Variable labels are stored as attributes.

read_survey( file_name, strip_html = TRUE, import_id = FALSE, time_zone = NULL, legacy = FALSE, add_column_map = TRUE, add_var_labels = TRUE, col_types = NULL )

Arguments

  • file_name: String. A CSV data file.

  • strip_html: Logical. If TRUE, then remove HTML tags from variable descriptions. Defaults to TRUE.

  • import_id: Logical. If TRUE, use Qualtrics import IDs instead of question IDs as column names. Defaults to FALSE.

  • time_zone: String. A local timezone to determine response date values. Defaults to NULL which corresponds to UTC time. See "Dates and Times" from Qualtrics for more information on format.

  • legacy: Logical. If TRUE, then import "legacy" format CSV files (as of 2017). Defaults to FALSE.

  • add_column_map: Logical. If TRUE, then a column map data frame will be added as an attribute to the main response data frame. This column map captures Qualtrics-provided metadata associated with the response download, such as an item description and internal ID's. Defaults to TRUE.

  • add_var_labels: Logical. If TRUE, then the item description from each variable (equivalent to the one in the column map) will be added as a "label" attribute using sjlabelled::set_label(). Useful for reference as well as cross-compatibility with other stats packages (e.g., Stata, see documentation in sjlabelled). Defaults to TRUE.

  • col_types: Optional. This argument provides a way to manually overwrite column types that may be incorrectly guessed. Takes a readr::cols()

    specification. See example below and readr::cols() for formatting details. Defaults to NULL.

Returns

A data frame. Variable labels are stored as attributes. They are not printed on the console but are visibile in the RStudio viewer.

Examples

## Not run: # Generic use of read_survey() df <- read_survey("<YOUR-PATH-TO-CSV-FILE>") ## End(Not run) # Example using current data format file <- system.file("extdata", "sample.csv", package = "qualtRics") df <- read_survey(file) # Example using legacy data format file <- system.file("extdata", "sample_legacy.csv", package = "qualtRics") df <- read_survey(file, legacy = TRUE) # Example changing column type file <- system.file("extdata", "sample.csv", package = "qualtRics") # Force EndDate to be a string df <- read_survey(file, col_types = readr::cols(EndDate = readr::col_character()))