Learn R Programming

⚠️There's a newer version (3.2.1) of this package.Take me there.

qualtRics (version 3.2.0)

Download 'Qualtrics' Survey Data

Description

Provides functions to access survey results directly into R using the 'Qualtrics' API. 'Qualtrics' is an online survey and data collection software platform. See for more information about the 'Qualtrics' API. This package is community-maintained and is not officially supported by 'Qualtrics'.

Copy Link

Version

Install

install.packages('qualtRics')

Monthly Downloads

3,316

Version

3.2.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/ropensci/qualtRics

Homepage

https://docs.ropensci.org/qualtRics/

Maintainer

Last Published

January 24th, 2024

Functions in qualtRics (3.2.0)

checkarg_time_zone

Checks time zone, setting default if needed:

export_responses_progress

Monitor progress from response request download, then obtain file download location

export_responses_filedownload

Downloads response data from location obtained from fetch_survey_progress (extracting from .zip file)

fetch_description

Download complete survey description using the Qualtrics v3 "Get Survey" API endpoint.

Extract column map from survey data download

Read a CSV file exported from Qualtrics

Read a CSV file exported from Qualtrics

Retrieve a data frame containing survey column mapping

Retrieve a data frame of all active surveys on Qualtrics

Download a survey and import it into R

qualtrics_response_codes

Checks responses against Qualtrics response codes and returns error message.

infer_data_types

Set proper data types on survey data.

export_responses_request

Runs 3-part request to export-responses endpoint, downloading and unzipping file

export_responses_init

Initiate a request to the export-responses API endpoint

Generate URL for specific API query by type and (if appropriate) ID

qualtrics_api_request

Send httr requests to Qualtrics API

survey_questions

Retrieve a data frame containing question IDs and labels

Download a survey and import it into R

checkarg_include_embedded

Check include_embedded and format for API call:

checkarg_file_name

Check if survey file specified in file_name exists

Convert multiple choice questions to ordered factors

getSurveyQuestions

Retrieve a data frame containing question IDs and labels

checkarg_tempdir

Check if the temporary directory exists:

Check limit for being integer >= 1:

fetch_distribution_history

Download distribution history data for a distribution from Qualtrics

list_distribution_links

Download distribution links for a distribution from Qualtrics

Download metadata for a survey

fetch_distributions

Download distribution data for a survey from Qualtrics

checkarg_ischaracter

Is character vector with no missing values:

Fetch a unique Qualtrics survey ID based on survey name in the Qualtrics UI

fetch_mailinglist

Download a mailing list from Qualtrics

create_raw_payload

Create properly-formatted JSON payload for API calls. Removes NULLS

construct_header

Construct a header to send to Qualtrics API

qualtRicsConfigFile

Prints an Example of a QualtRics Configuration File to the Console.

qualtrics_api_credentials

Install Qualtrics credentials in your .Renviron file for repeated use

Retrieve a data frame of all active surveys on Qualtrics

check_existing_download

Check if downloaded file already exists

all_mailinglists

Retrieve a data frame of all mailing lists from Qualtrics

check_credentials

General check that credentials are present

check_for_warnings

Check if httr GET result contains a warning

checkarg_isintegerish

Is integerish (length-1 numeric w/o any fractional component)

checkarg_col_types

col_types must be a col_spec object from readr

checkarg_elements

Check if elements given in fetch_description are properly specified

checkarg_base_url

Checking and re-formatting base_url:

checkarg_convert_label_breakouts

Check conditions around combinations of convert, label, and breakout_sets

checkarg_datetime

Title Check date-time-like inputs and convert them to ISO8601 (with time zone)

checkarg_isstring

Is string (length-1 character)

checkarg_isboolean

Is boolean (length-1 logical)

Check if elements given in metadata's 'get' are properly specified

checkarg_fetch_id_data

Check if data for fetch_id() is correct

checkarg_include_metadata

Check that include_metadata has the right elements & format for API call

checkarg_include_questions

Check that include_questions uses the QID format, and format for API call: