Skip to content

Commit

Permalink
Add paper
Browse files Browse the repository at this point in the history
  • Loading branch information
JasperHG90 committed Feb 4, 2018
1 parent 9e04062 commit 41db61e
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 0 deletions.
37 changes: 37 additions & 0 deletions paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
@article{qualtrics_main,
title={Qualtrics [software]},
author={Qualtrics, LLC},
journal={Utah, USA: Qualtrics},
url={http://www.qualtrics.com},
year={2018}
}

@misc{ginn_qualtrics_2017,
title = {{qualtRics}: {Download} {Qualtrics} {Survey} {Data} {Directly} into {R}},
copyright = {GPL-3 {\textbar} file LICENSE},
shorttitle = {{qualtRics}},
url = {https://cran.r-project.org/web/packages/qualtRics/index.html},
abstract = {Qualtrics {\textless}https://www.qualtrics.com/about/{\textgreater}
allows users to collect online data through surveys.
This package contains convenience functions to pull
survey results straight into R using the Qualtrics
API. See {\textless}https://api.qualtrics.com/{\textgreater} for more
information about the Qualtrics API. This package is
community-maintained and is not officially supported
by Qualtrics.},
urldate = {2018-02-03},
author = {Ginn, Jasper},
month = oct,
year = {2017},
file = {R Package Snapshot:/Users/Jasper/Zotero/storage/MLX9KP4G/index.html:text/html}
}

@misc{noauthor_getting_nodate,
author= {Qualtrics},
title = {Getting {Survey} {Responses}},
url = {https://api.qualtrics.com/docs/response-exports},
abstract = {How to get responses to your surveys.},
language = {en},
urldate = {2018-02-03},
file = {Snapshot:/Users/Jasper/Zotero/storage/CB5NIANY/response-exports.html:text/html}
}
28 changes: 28 additions & 0 deletions paper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: 'qualtRics: retrieve survey data using the Qualtrics API'
authors:
- affiliation: 1
name: Jasper Ginn
orcid: 0000-0002-5019-2923
date: "2 February 2018"
output: pdf_document
bibliography: paper.bib
tags:
- R
- survey data
- API
- Qualtrics
affiliations:
- index: 1
name: Ecole Polytechnique Federale de Lausanne (EPFL)
---

# Summary

Qualtrics [@qualtrics_main] allows users to create and disseminate online surveys. It is used by researchers to field responses for academic research. While users can manually download survey responses from Qualtrics, importing this data into R is cumbersome. The R package `qualtRics` [@ginn_qualtrics_2017] focuses on the retrieval of survey data using the Qualtrics API and aims to reduce the pre-processing steps needed to prepare this data for analysis. Currently, the package is the only package on CRAN that offers such functionality, and is included in the official Qualtrics API documentation [@noauthor_getting_nodate].

The primary goal of the package is to provide a bridge between the Qualtrics user interface (where the survey is designed) and R (where the results can be analyzed) by using as few steps as possible. Users can store their API credentials in a file in an R project root directory that automatically loads when the library is called. This eliminates the need to remember API credentials and prevents the user from accidentally sharing sensitive information should they want to share their work. The package contains three core functions to retrieve survey data. The first of these functions - `getSurveys()` - retrieves a data frame containing an overview of surveys to which the user has access. Using a unique survey id, the user can download and import their data using the second core function (`getSurvey()`). This function takes care of requesting, downloading and unpacking the data. It is then imported into R with the `readSurvey()` function. This last function can also be used to import manual data exports and supports both current and legacy data formats.

Apart from the above functionality, the package supports the automatic conversion of single-choice multiple choice questions. Using the rich metadata that Qualtrics provides about surveys, it is possible to automatically convert ordinal data to ordered factors. This functionality will be expanded on an ongoing basis to include other variable types.

# References

0 comments on commit 41db61e

Please sign in to comment.