Description Usage Arguments Author(s) See Also Examples
View source: R/qualtrics_get_survey.R
Export a qualtrics survey you own and import the survey directly into R.
1 2 3 4 5 6 7 | getSurvey(surveyID, lastResponseId = NULL, startDate = NULL,
endDate = NULL, seenUnansweredRecode = NULL, limit = NULL,
includedQuestionIds = NULL, saveDir = NULL, forceRequest = FALSE, ...)
qualtrics_get_survey(surveyID, lastResponseId = NULL, startDate = NULL,
endDate = NULL, seenUnansweredRecode = NULL, limit = NULL,
includedQuestionIds = NULL, saveDir = NULL, forceRequest = FALSE, ...)
|
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. |
saveDir |
String. Directory where survey results will be stored. Defaults to a temporary directory which is cleaned when your R session is terminated. This argument is useful if you'd like to store survey results. The downloaded survey will be stored as an RDS file (see readRDS). |
forceRequest |
Logical. getSurvey() saves each survey in a temporary directory so that it can quickly be retrieved later. If forceRequest is TRUE, getSurvey() always downloads the survey from the API instead of loading it from the temporary directory. Defaults to FALSE. |
... |
optional arguments. You can pass all arguments listed in |
Jasper Ginn
See https://api.qualtrics.com/docs/csv for documentation on the Qualtrics API.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | ## Not run:
# Register your Qualtrics credentials if you haven't already
registerOptions(api_token = "<YOUR-API-TOKEN>",
base_url = "<YOUR-ROOT-URL>")
# Retrieve a list of surveys
surveys <- getSurveys()
# Retrieve a single survey
mysurvey <- getSurvey(surveyID = surveys$id[6],
saveDir = 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],
saveDir = 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],
saveDir = tempdir(),
includedQuestionIds = c("QID1", "QID2", "QID3"),
verbose = TRUE)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.