getSurvey
Export a survey and download into R
Export a qualtrics survey you own and import the survey directly into R.
Usage
getSurvey(surveyID, lastResponseId = NULL, startDate = NULL,
endDate = NULL, seenUnansweredRecode = NULL, limit = NULL,
includedQuestionIds = NULL, save_dir = NULL, force_request = FALSE, ...)Arguments
- surveyID
String. Unique ID for the survey you want to download. Returned as 'id' by the getSurveys function.
- lastResponseId
String. Export all responses received after the specified response. Defaults to NULL.
- startDate
String. Filter to only exports responses recorded after the specified date. Accepts dates as character strings in format "YYYY-MM-DD". Defaults to NULL.
- endDate
String. Filter to only exports responses recorded before the specified date. Accepts dates as character strings in format "YYYY-MM-DD". Defaults to NULL.
- seenUnansweredRecode
String. Recode seen but unanswered questions with a string value. Defaults to NULL.
- limit
Integer. Maximum number of responses exported. Defaults to NULL (all responses).
- includedQuestionIds
Vector of strings (e.g. c('QID1', 'QID2', 'QID3'). Export only specified questions. Defaults to NULL.
- save_dir
String. Directory where survey results will be stored. Defaults to a temporary directory which is cleaned when your R session is terminated. This parameter is useful if you'd like to store survey results. The downloaded survey will be stored as an RDS file (see readRDS).
- force_request
Logical. getSurvey() saves each survey in a temporary directory so that it can quickly be retrieved later. If force_request is TRUE, getSurvey() always downloads the survey from the API instead of loading it from the temporary directory. Defaults to FALSE.
- ...
optional arguments. See
registerOptionsfor arguments.
See Also
See https://api.qualtrics.com/docs/csv for documentation on the Qualtrics API.
Examples
# NOT RUN {
# Register your Qualtrics credentials if you haven't already
registerOptions(api_token="<YOUR-API-TOKEN>", root_url="<YOUR-ROOT-URL>")
# Retrieve a list of surveys
surveys <- getSurveys()
# Retrieve a single survey
mysurvey <- getSurvey(surveyID = surveys$id[6],
save_dir = tempdir(),
verbose=TRUE)
# You can use the same parameters as those found in the qualtrics API documentation
# Found here: https://api.qualtrics.com/docs/csv
mysurvey <- getSurvey(surveyID = surveys$id[6],
save_dir = tempdir(),
startDate = "2017-01-01",
endDate = "2017-01-31",
limit = 100,
useLabels = TRUE,
seenUnansweredRecode = "UNANS",
verbose=TRUE)
# You can also choose to only download an export with specific questions using
# the \code{\link[getSurveyQuestions]{getSurveyQuestions}} function.
# Retrieve questions for a survey
questions <- getSurveyQuestions(surveyID = surveys$id[6])
# Retrieve a single survey, filtering for questions I want.
mysurvey <- getSurvey(surveyID = surveys$id[6],
save_dir = tempdir(),
includedQuestionIds = c("QID1", "QID2", "QID3"),
verbose=TRUE)
# }