• Stars
    star
    215
  • Rank 180,776 (Top 4 %)
  • Language
    R
  • License
    Other
  • Created almost 8 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Download ⬇️ Qualtrics survey data directly into R!

qualtRics

Authors: Julia Silge, Joseph O’Brien, Jasper Ginn
License: MIT

R-CMD-check CRAN_Status_Badge Codecov test coverage rOpenSci DOI DOI Downloads Total Downloads Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Qualtrics is an online survey and data collection software platform. Qualtrics is used across many domains in both academia and industry for online surveys and research. While users can manually download survey responses from Qualtrics through a browser, importing this data into R is then cumbersome. The qualtRics R package implements the retrieval of survey data using the Qualtrics API and aims to reduce the pre-processing steps needed in analyzing such surveys. Currently, this package is the only package on CRAN that offers such functionality, and is included in the official Qualtrics API documentation.

Note that your institution must support API access and that it must be enabled for your account. Whoever manages your Qualtrics account can help you with this. Please refer to the Qualtrics documentation to find your API token.

The authors of this package are not affiliated with Qualtrics, and Qualtrics does not offer support for this package. For specific information about the Qualtrics API, you can refer to the official documentation.

Installation

This package can be installed from CRAN:

install.packages("qualtRics")

Alternatively, you can install the development version with the remotes package (or alternatively, devtools):

install.packages("remotes")
remotes::install_github("ropensci/qualtRics")

Access your Qualtrics data

Currently, the package contains three core functions:

  1. all_surveys() fetches a list of all surveys that you own or have access to from Qualtrics.
  2. fetch_survey() downloads a survey from Qualtrics and loads it into R.
  3. read_survey() allows you to read CSV files you download manually from Qualtrics.

It also contains multiple helper functions, including:

  1. qualtrics_api_credentials() stores your API key and base URL in environment variables.
  2. survey_questions() retrieves a data frame containing questions and question IDs for a survey; extract_colmap() retrieves a similar data frame with more detailed mapping from columns to labels.
  3. metadata() retrieves metadata about your survey, such as questions, survey flow, number of responses etc.

Note that you can only export surveys that you own, or to which you have been given administration rights.

Register your Qualtrics credentials

There are two important credentials you need to authenticate with the Qualtrics API. These are your API key and datacenter-specific base URL. The base URL you pass to the qualtRics package should look like yourdatacenterid.qualtrics.com, without a scheme such as https://. The Qualtrics API documentation explains how you can find your base URL.

You can store your API credentials QUALTRICS_API_KEY and QUALTRICS_BASE_URL in your .Renviron file for repeated use across sessions. The qualtRics package has a function to help with this.

library(qualtRics)

qualtrics_api_credentials(api_key = "<YOUR-QUALTRICS_API_KEY>", 
                          base_url = "<YOUR-QUALTRICS_BASE_URL>",
                          install = TRUE)

After you use this function, reload your environment (readRenviron("~/.Renviron")) so you can use the credentials without restarting R.

A simple Qualtrics workflow

Once your Qualtrics API credentials are stored, you can see what surveys are available to you.

surveys <- all_surveys() 

You can then download the data from any of these individual surveys (for example, perhaps the sixth one) directly into R.

mysurvey <- fetch_survey(surveyID = surveys$id[6], 
                         verbose = TRUE)

See the qualtRics vignette for more details on variable metadata, automatic conversion of variables, retrieving responses between specific dates or for specific survey items, and more.

Related work

  • Jason Bryer wrote an R package to work with the previous version of the Qualtrics API
  • QualtricsTools creates automatic reports in shiny.
  • qsurvey by James Dunham focuses on testing and review of surveys before fielding, and analysis of responses afterward.

Community Guidelines

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Feedback, bug reports (and fixes!), and feature requests are welcome; file issues or seek support here.

ropensci_footer

More Repositories

1

drake

An R-focused pipeline toolkit for reproducibility and high-performance computing
R
1,331
star
2

skimr

A frictionless, pipeable approach to dealing with summary statistics
HTML
1,095
star
3

targets

Function-oriented Make-like declarative workflows for R
R
880
star
4

rtweet

🐦 R client for interacting with Twitter's [stream and REST] APIs
R
785
star
5

tabulizer

Bindings for Tabula PDF Table Extractor Library
R
518
star
6

pdftools

Text Extraction, Rendering and Converting of PDF Documents
C++
489
star
7

magick

Magic, madness, heaven, sin
R
440
star
8

visdat

Preliminary Exploratory Visualisation of Data
R
439
star
9

stplanr

Sustainable transport planning with R
R
414
star
10

RSelenium

An R client for Selenium Remote WebDriver
R
332
star
11

rnoaa

R interface to many NOAA data APIs
R
326
star
12

osmdata

R package for downloading OpenStreetMap data
C++
309
star
13

charlatan

Create fake data in R
R
289
star
14

software-review

rOpenSci Software Peer Review.
R
279
star
15

iheatmapr

Complex, interactive heatmaps in R
R
259
star
16

taxize

A taxonomic toolbelt for R
R
250
star
17

rrrpkg

Use of an R package to facilitate reproducible research
248
star
18

elastic

R client for the Elasticsearch HTTP API
R
245
star
19

tesseract

Bindings to Tesseract OCR engine for R
R
236
star
20

git2r

R bindings to the libgit2 library
R
212
star
21

biomartr

Genomic Data Retrieval with R
R
207
star
22

writexl

Portable, light-weight data frame to xlsx exporter for R
C
202
star
23

googleLanguageR

R client for the Google Translation API, Google Cloud Natural Language API and Google Cloud Speech API
HTML
192
star
24

rnaturalearth

An R package to hold and facilitate interaction with natural earth map data 🌍
R
191
star
25

textreuse

Detect text reuse and document similarity
R
188
star
26

piggyback

📦 for using large(r) data files on GitHub
R
179
star
27

tokenizers

Fast, Consistent Tokenization of Natural Language Text
R
179
star
28

rentrez

talk with NCBI entrez using R
R
178
star
29

rcrossref

R client for various CrossRef APIs
R
165
star
30

osmextract

Download and import OpenStreetMap data from Geofabrik and other providers
R
163
star
31

dataspice

🌶️ Create lightweight schema.org descriptions of your datasets
R
156
star
32

tic

Tasks Integrating Continuously: CI-Agnostic Workflow Definitions
R
153
star
33

rgbif

Interface to the Global Biodiversity Information Facility API
R
151
star
34

webchem

Chemical Information from the Web
R
149
star
35

geojsonio

Convert many data formats to & from GeoJSON & TopoJSON
R
148
star
36

MODIStsp

An "R" package for automatic download and preprocessing of MODIS Land Products Time Series
R
147
star
37

tsbox

tsbox: Class-Agnostic Time Series in R
R
146
star
38

DataPackageR

An R package to enable reproducible data processing, packaging and sharing.
R
145
star
39

dev_guide

rOpenSci Packages: Development, Maintenance, and Peer Review
R
141
star
40

ghql

GraphQL R client
R
141
star
41

jqr

R interface to jq
R
139
star
42

osfr

R interface to the Open Science Framework (OSF)
R
139
star
43

osmplotr

Data visualisation using OpenStreetMap objects
R
130
star
44

opencv

R bindings for OpenCV
C++
130
star
45

ssh

Native SSH client in R based on libssh
C
126
star
46

tarchetypes

Archetypes for targets and pipelines
R
120
star
47

RefManageR

R package RefManageR
R
114
star
48

ezknitr

Avoid the typical working directory pain when using 'knitr'
R
112
star
49

spocc

Species occurrence data toolkit for R
R
109
star
50

hunspell

High-Performance Stemmer, Tokenizer, and Spell Checker for R
C++
106
star
51

crul

R6 based http client for R (for developers)
R
102
star
52

gistr

Interact with GitHub gists from R
R
101
star
53

spelling

Tools for Spell Checking in R
R
101
star
54

weathercan

R package for downloading weather data from Environment and Climate Change Canada
R
100
star
55

rfishbase

R interface to the fishbase.org database
R
100
star
56

UCSCXenaTools

📦 An R package for accessing genomics data from UCSC Xena platform, from cancer multi-omics to single-cell RNA-seq https://cran.r-project.org/web/packages/UCSCXenaTools/
R
99
star
57

gutenbergr

Search and download public domain texts from Project Gutenberg
R
98
star
58

bib2df

Parse a BibTeX file to a tibble
R
97
star
59

ckanr

R client for the CKAN API
R
97
star
60

git2rdata

An R package for storing and retrieving data.frames in git repositories.
R
97
star
61

nasapower

API Client for NASA POWER Global Meteorology, Surface Solar Energy and Climatology in R
R
96
star
62

rsvg

SVG renderer for R based on librsvg2
C
95
star
63

EML

Ecological Metadata Language interface for R: synthesis and integration of heterogenous data
R
94
star
64

FedData

Functions to Automate Downloading Geospatial Data Available from Several Federated Data Sources
R
93
star
65

cyphr

:shipit: Humane encryption
R
92
star
66

openalexR

Getting bibliographic records from OpenAlex
R
89
star
67

av

Working with Video in R
C
88
star
68

mapscanner

R package to print maps, draw on them, and scan them back in
R
87
star
69

opencage

🌐 R package for the OpenCage API -- both forward and reverse geocoding 🌐
R
87
star
70

GSODR

API Client for Global Surface Summary of the Day ('GSOD') Weather Data Client in R
R
85
star
71

tidync

NetCDF exploration and data extraction
R
85
star
72

rzmq

R package for ZMQ
C++
82
star
73

gittargets

Data version control for reproducible analysis pipelines in R with {targets}.
R
81
star
74

rebird

Wrapper to the eBird API
R
79
star
75

bikedata

🚲 Extract data from public hire bicycle systems
R
79
star
76

vcr

Record HTTP calls and replay them
R
78
star
77

historydata

Datasets for Historians
R
78
star
78

dittodb

dittodb: A Test Environment for DB Queries in R
R
78
star
79

arkdb

Archive and unarchive databases as flat text files
R
78
star
80

fingertipsR

R package to interact with Public Health England’s Fingertips data tool
R
78
star
81

CoordinateCleaner

Automated flagging of common spatial and temporal errors in biological and palaeontological collection data, for the use in conservation, ecology and palaeontology.
HTML
77
star
82

smapr

An R package for acquisition and processing of NASA SMAP data
R
77
star
83

nodbi

Document DBI connector for R
R
76
star
84

opentripplanner

An R package to set up and use OpenTripPlanner (OTP) as a local or remote multimodal trip planner.
R
73
star
85

nlrx

nlrx NetLogo R
R
71
star
86

rb3

A bunch of downloaders and parsers for data delivered from B3
R
69
star
87

tidyhydat

An R package to import Water Survey of Canada hydrometric data and make it tidy
R
69
star
88

slopes

Package to calculate slopes of roads, rivers and trajectories
R
68
star
89

robotstxt

robots.txt file parsing and checking for R
R
68
star
90

codemetar

an R package for generating and working with codemeta
R
65
star
91

tradestatistics

R package to access Open Trade Statistics API
R
65
star
92

unconf17

Website for 2017 rOpenSci Unconf
JavaScript
64
star
93

roadoi

Use Unpaywall with R
R
64
star
94

terrainr

Get DEMs and orthoimagery from the USGS National Map, georeference your images and merge rasters, and visualize with Unity 3D
R
64
star
95

NLMR

📦 R package to simulate neutral landscape models 🏔
R
63
star
96

parzer

Parse geographic coordinates
R
63
star
97

tiler

Generate geographic and non-geographic map tiles from R
R
63
star
98

comtradr

Functions for Interacting with the UN Comtrade API
R
63
star
99

rWBclimate

R interface for the World Bank climate data
R
62
star
100

stats19

R package for working with open road traffic casualty data from Great Britain
R
59
star