Usage
Currently, the package contains three functions:
- getSurveys() fetches a list of all surveys that you own or have access to from Qualtrics.
- getSurvey() downloads a survey from Qualtrics and loads it into R.
- readSurvey() allows you to read CSV files you download manually from Qualtrics.
Note that you can only export surveys that you own, or to which you have been given explicit administration rights.
Commands
Load the package:
library(qualtRics)Register your Qualtrics API key. You need to do this once every R session:
registerApiKey(API.TOKEN = "<yourapitoken>")Get a data frame of surveys:
surveys <- getSurveys(root_url="https://leidenuniv.eu.qualtrics.com") # URL is for my own institutionNote that, while requests will work without a root url for the getSurveys function, it is desirable that you supply it. Supplying the correct url will reduce the number of errors you’ll experience. The getSurvey function requires you to pass this root url. Please refer to the official documentation to find out your institution-specific root url.
Export a survey and load it into R:
mysurvey <- getSurvey(surveyID = surveys$id[6],
root_url = "https://leidenuniv.eu.qualtrics.com",
verbose = TRUE)You can add a from/to date to only retrieve responses between those dates:
surv <- getSurvey(survs$id[4],
root_url = "https://leidenuniv.eu.qualtrics.com",
startDate = "2016-09-18",
endDate = "2016-10-01",
useLabels = FALSE,
verbose = TRUE)You may also reference a response ID. getSurvey will then download all responses that were submitted after that response:
surv <- getSurvey(survs$id[4],
root_url = "https://leidenuniv.eu.qualtrics.com",
lastResponseId = "R_3mmovCIeMllvsER",
useLabels = FALSE,
verbose = TRUE)You can store the results in a specific location if you like:
mysurvey <- getSurvey(surveyID = surveys$id[6],
save_dir = "/users/jasper/desktop/",
root_url = "https://leidenuniv.eu.qualtrics.com",
verbose = TRUE)Note that surveys that are stored in this way will be saved as an RDS file rather than e.g. a CSV. Reading an RDS file is as straightforward as this:
mysurvey <- readRDS(file = "/users/jasper/desktop/mysurvey.rds")You can read a survey from a local file using readSurvey:
mysurvey <- readSurvey("/users/jasper/desktop/mysurvey.csv")To avoid special characters (mainly periods) in header names, readSurvey uses question labels as the header names. The question belonging to that label is then added using the sjmisc package. Qualtrics gives names to these labels automatically, but you can easily change them.
