qualtRicsConfigFile

0th

Percentile

Prints an example of a qualtRics configuration file to the console.

Prints an example of a qualtRics configuration file to the console.

Usage
qualtRicsConfigFile(api_token = NULL, root_url = NULL, verbose = TRUE,
  useLabels = TRUE, convertStandardColumns = TRUE, useLocalTime = FALSE,
  dateWarning = TRUE)
Arguments
api_token

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

root_url

String. Root 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.

convertStandardColumns

Logical. If TRUE, then the getSurvey function will convert general data columns (first name, last name, lat, lon, ip address, startdate, enddate etc.) to their proper format. 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.

See Also

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

Aliases
  • qualtRicsConfigFile
Examples
# NOT RUN {
# Execute this line to get instructions on how to make a .qualtrics.yml config file.
qualtRicsConfigFile()
# }
# NOT RUN {
# }
Documentation reproduced from package qualtRics, version 2.0, License: GPL-3 | file LICENSE

Community examples

Looks like there are no examples yet.