qualtRics (version 3.0)

metadata: Download metadata about a survey

Description

Using this function, you can retrieve metadata about your survey. This information includes question metadata (type, options, choices etc), number of responses, general metadata, survey flow etc.

Usage

metadata(surveyID, get = list(), ...)

Arguments

surveyID

String. Unique ID for the survey you want to download. Returned as 'id' by the getSurveys function.

get

list containing TRUE/FALSE values of one of the following: metadata, questions,responsecounts, blocks, flow, embedded_data or comments. A TRUE value will return that specific element. If you leave this empty, the function will return the metadata, questions and responsecounts elements. See examples below for more information

...

additional options. User may pass an argument called 'questions', which should be a vector containing the names of questions for which you want to return metadata.

Examples

# NOT RUN {
# Register your Qualtrics credentials if you haven't already
# Note that you need to pass both the 'api_token' and 'root_url'
# parameters if you call this function for the first time.
registerOptions(api_token="<YOUR-API-TOKEN>", root_url="<YOUR-ROOT-URL>")
# Get metadata for a survey
md <- metadata(surveyID = id)
# Get metadata with specific elements
md_specific <- metadata(surveyID= id, get=list(questions=FALSE, flow=TRUE))
# Get specific question metadata
question_specific <- metadata(surveyID=id, get=list(questions=TRUE), questions=c("Q1","Q2"))
# }
# NOT RUN {
# }