Package index

Authentication & Credentials

Functions for setting, checking, and managing Survey Solutions credentials.

suso_set_key()

Set all credentials at once

suso_get_api_key()

Get credentials

suso_get_default_key()

Checks if credentials are present

suso_clear_keys()

Clear Credentials

suso_keys()

Survey Solutions API credentials

suso_PwCheck()

Utility function to check if credentials are correct

suso_set_workspace()

Convenience function to switch workspace

Workspace Administration

Create, inspect, update, and enable/disable multi-tenant workspaces.

suso_getWorkspace()

Survey Solutions API call for workspace information

suso_createWorkspace()

Survey Solutions API call to create workspace

suso_updateWorkspace()

Update workspace details

suso_deleteWorkspace()

Delete a workspace

suso_enableWorkspace()

Enable or disable a workspace

suso_assignWorkspace()

Survey Solutions API call to assign workspace (!! WORKS ONLY WITH ADMIN CREDENTIALS)

Questionnaires & Survey Design

Inspect questionnaire specifications, routing, validation rules, codebooks, and settings.

suso_getQuestDetails()

Survey Solutions API call for questionnaire

suso_questRecordAudio()

Survey Solutions API call for questionnaire audio recording setting

suso_questCriticalityLevel()

Survey Solutions API call for questionnaire criticality level setting

User & Field Staff Management

Create, query, and manage supervisors, interviewers, and headquarters staff.

suso_createUSER()

Survey Solutions API call for User Creation

suso_getUSR()

Survey Solutions API call for info on any user

suso_getSV()

Survey Solutions API call for list of supervisors

suso_getSV_info()

Survey Solutions API call for supervisor info

suso_archUSR()

Survey Solutions API call (un-) archive user

Assignment Operations

Create, query, and reassign sample assignments with preloaded data.

suso_set_assignments()

Survey Solutions API call for assignment manipulation

suso_get_assignments()

Survey Solutions API call for assignment list

suso_createASS()

Survey Solutions API call for Assignment Creation

Interview Workflow & Quality Control

Track interviews, approve/reject, leave comments, reassign, and download PDF transcripts.

suso_getAllInterviewQuestionnaire()

Survey Solutions API call to retrieve all interviews for a specific questionnaire

suso_getINT()

Survey Solutions API call for list of interviewers

suso_getINT_info()

Survey Solutions API call for info on interviewers

suso_getAllAnswerInterview()

Survey Solutions API call to retrieve all answers for a specific interview

suso_getAllHistoryInterview()

Get all history for a specific interview

suso_assignInterview()

Assign interview to interviewer or supervisor

suso_commentInterview()

Leave a comment on a question in an interview

suso_patchApproveInterview()

Approve interviews either as supervisor or as headquarter.

suso_patchRejectInterview()

Reject interviews either as supervisor or as headquarter.

suso_deleteInterview()

Delete an interview

suso_getInterviewPDF()

Download interview PDF transcript

suso_createCALEV() suso_updateCALEV() suso_delCALEV()

Create, update or delete a calendar event

Data Export (v2 API)

End-to-end export pipelines, progress monitoring, and archive handling.

suso_export()

Survey Solutions API call to generate and download the data

suso_getExportList()

Survey Solutions API call to list export processes

suso_getExportProcess()

Survey Solutions API call to get detailed information about an export process

suso_cancelExport()

Survey Solutions API call to cancel an export process

Paradata Processing

Export, parse, and analyze event paradata, pauses, and spatial traces.

suso_export_paradata()

Export Survey Solutions paradata

Maps & Spatial Management

Upload offline basemaps, assign maps to interviewers, and generate spatial reports.

suso_mapupload()

Upload map to server

suso_mapinfo()

Receive maps currently uploaded to the server

suso_mapassign()

Assigns/Unassign a map to a user

suso_deletemap()

Delete Map from Server

suso_mapreport()

Create a Map Report

Statistics & Server Settings

Question response statistics and global headquarters notices.

suso_get_stats()

Survey Solutions API call for Summary Tables

suso_getStatsQuestionnaires()

Survey Solutions API call for questionnaires with statistics

suso_getQuestionsQuestionnaire()

Survey Solutions API call for questions and responses from single questionnaire

suso_get_stats_interview()

Get statistics for interview

suso_globalNotice()

Survey Solutions API call for Headquarters Global Notice settings

Classes & S3 Methods

Custom data classes extending data.table with rich survey metadata.

UserClass()

User Classes & Methods

is.UserClass()

Function to check if an object is of class UserClass

assignmentClass()

Assignment Classes & Methods

is.assignmentClass()

Function to check if an object is of class assignmentClass

exportClass()

Export Classes & Methods

is.exportClass()

Function to check if an object is of class exportClass

getinfo()

assignmentClass methods

summaryTable()

S3 method to create a summary table of numeric variables for an exportClass object

summaryTable(<UserClass>)

S3 method to create a summary table of users for UserClass object

boxplot_summary()

S3 method to create a box plot of numeric variables for an exportClass object

Package Options & Shiny Helpers

Configuration options for parallel processing and Shiny notifications.

suso.options

Configuration options used for the SurveySolutionsAPIv2 package

suso_set_maxpar_req()

Convenience Function to modify the maximum number of parallel requests option

suso_set_pwcheck_mess() suso_set_prog_mess()

Convenience functions to modify user notification text