qualtRics (version 3.1.1)

qualtRicsConfigFile: Prints an Example of a QualtRics Configuration File to the Console.

Description

This function is soft deprecated; use qualtrics_api_credentials instead.

Usage

qualtRicsConfigFile(api_token = NULL, base_url = NULL,
  verbose = TRUE, useLabels = TRUE, convertVariables = TRUE,
  useLocalTime = FALSE, dateWarning = TRUE, root_url = NULL)

Arguments

api_token

String. API token. Available in your qualtrics account (see: https://api.qualtrics.com/docs/authentication)

base_url

String. Base url for your institution (see: https://api.qualtrics.com/docs/root-url)

verbose

Logical. If TRUE, verbose messages will be printed to the R console. Defaults to TRUE.

useLabels

Logical. TRUE to export survey responses as Choice Text or FALSE to export survey responses as values.

convertVariables

Logical. If TRUE, then the getSurvey function will convert certain question types (e.g. multiple choice) to proper data type in R. Defaults to TRUE.

useLocalTime

Logical. Use local timezone to determine response date values? Defaults to FALSE. See https://api.qualtrics.com/docs/dates-and-times for more information.

dateWarning

Logical. Once per session, qualtRics will emit a warning about date conversion for surveys. You can turn this warning off by changing the flag to FALSE. Defaults to TRUE.

root_url

String. Deprecated. Use `base_url` instead. This will be removed in future versions.

See Also

See https://api.qualtrics.com/docs/root-url for documentation on the Qualtrics API. See https://github.com/ropensci/qualtRics/blob/master/README.md#using-a-configuration-file for more information about the qualtRics configuration file.

Examples

# NOT RUN {
# Execute this line to get instructions on how to make a .qualtrics.yml config file.
qualtRicsConfigFile()
# }
# NOT RUN {
# }