download_matching: Downloads data for questionnaires that match
In arthur-shaw/susoflows: Executes common workflows with Survey Solutions' API

download_matching

R Documentation

Downloads data for questionnaires that match

Description

If the export file is ready, this function downloads it to the target directory specified in path. If the file is not ready, print a message describing the situation.

Usage

download_matching(
  matches,
  export_type,
  interview_status = "All",
  from = "",
  to = "",
  access_token = "",
  refresh_token = "",
  storage_type = "",
  translation_id = "",
  include_meta = TRUE,
  path,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

`matches`	Atomic character vector. Character string to be detected in questionnaire title. May be a string, sub-string, or regex.
`export_type`	Type of data to export. Values: `c("Tabular", "STATA", "SPSS", "Binary", "DDI", "Paradata")`
`interview_status`	Status of interviews to export. Values: `c("All", "SupervisorAssigned", "InterviewerAssigned", "Completed", "RejectedBySupervisor", "ApprovedBySupervisor", "RejectedByHeadquarters", "ApprovedByHeadquarters")`
`from`	Start date for interviews to export. date-time, UTC
`to`	End date for interviews to export. date-time, UTC
`access_token`	Access token to external storage. Relevant only if external cloud storage is destination for the export file.
`refresh_token`	Refresh token to external storage.Relevant only if external cloud storage is destination for the export file.
`storage_type`	External storage type, if relevant. Values: `c("Dropbox", "OneDrive", "GoogleDrive")`
`translation_id`	Translation ID for variable and value labels to include in export files.
`include_meta`	Logical. If `TRUE`, include questionnaire metadata in export file.
`path`	File path where export file should be downloaded
`server`	Full server web address (e.g., `https://demo.mysurvey.solutions`, `https://my.domain`)
`workspace`	Character. Name of the workspace whose data to download.
`user`	API user name
`password`	API password