find_matching_qnrs: Get list of questionnaires with a matching title.

In arthur-shaw/susoflows: Executes common workflows with Survey Solutions' API

Get list of questionnaires with a matching title.

Description

Get a data frame of questionnaires that match the character vector provided.

Usage

find_matching_qnrs(
  matches,
  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.
server	Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose questionnaires to query.
user	API user name
password	API password

Details

If matching questionnaires are found, return a data frame with attributes. These attributes can be used, among other things, to find the necessary parameters for downloading any associated data.

If no matching questionnaires are found, return a warning message.

In both cases, print the outcome to the console for information.

Value

Data frame of matching questionnaires, if successful; warning message, if not successful.

arthur-shaw/susoflows documentation built on April 14, 2025, 4:02 p.m.