Skip to content
Christian Testa edited this page May 31, 2017 · 16 revisions

Welcome to the QualtricsTools wiki.

What is QualtricsTools?

QualtricsTools is an R package that automatically processes Qualtrics survey data into reports showing the breakdowns of responses to each question. The package can create question response reports, appendices of free responses, question dictionaries, and even reports split into response based categories of respondents. This package uses the R web-application framework Shiny, the universal document converter Pandoc, Roxygen2 documentation, and much more.

A slideshow of the QualtricsTools web app

Installation

Before installing, you must install R or Rstudio, devtools, Rtools (if you're on Windows), and Pandoc. For Rtools with Windows, please make sure Rtools is added to the Path environment variable. After installing each of the prerequisites, to install QualtricsTools run the following in R:

devtools::install_github("ctesta01/QualtricsTools")

To run the Shiny app, load the package and then call the app() function.

library(QualtricsTools)
QualtricsTools::app()

The QualtricsTools Shiny app should now be running! Enjoy. To update your version of QualtricsTools to the most recent version, run devtools::install_github("ctesta01/QualtricsTools") again.

Most Useful Functions

Here are some of the most high level functions in the application. Be sure to library(QualtricsTools) before trying to run any of these. Running these commands without parameters like as follows results in interactive prompts for the survey data and other settings in order to cut down on the need to repeatedly type or copy long file paths. Check out the documentation for how to use each of these explicitly.

# Load and Process Survey Data into R
get_setup()

# Start and run the Shiny app
app()

# Create a Report of Question Results Tables
make_results_tables()

# Create a Report of Text Appendices, for each free response part of the survey
make_text_appendices()

Usage and Reference Guides

The functionality of the web application and R package are documented in the following guides. Beyond this, almost all functions have Roxygen generated documentation which means that after running library(QualtricsTools) you can run help(function) or ?function on any function in QualtricsTools to check out the Roxygen2 generated documentation.

Frequently Asked Questions

Check out our FAQ for more help.