Introduction | 1. Workspace Administration | Creating a New Workspace | Updating Workspace Details | Enabling and Disabling Workspaces | 2. Managing Users and Field Staff | Batch Creating Enumerators | Querying Field Staff with UserClass | 3. Creating and Managing Assignments | Creating Preloaded Assignments | Querying Existing Assignments with assignmentClass | Reassigning Work and Modifying Assignments | 4. Map Management for Spatial Surveys | Uploading and Assigning Maps | Generating Spatial Reports
Package: SurveySolutionsAPIv2 0.1.2
SurveySolutionsAPIv2: Comprehensive API Access to Your 'Survey Solutions' Server Using 'httr2'
A comprehensive suite of functions for interfacing with the 'Survey Solutions' APIs (<https://demo.mysurvey.solutions/apidocs/index.html> and <https://docs.mysurvey.solutions/>). It supports all the current POST, GET, and PATCH requests of the 'REST' API and extends its capabilities by integrating selected 'GraphQL' API queries and mutations when 'REST' API equivalents are not available. Designed for ease of use, it includes several convenience functions to streamline operations. The package ensures that data retrieved from the API is automatically transformed into a single, easy-to-use data frame or data table, optimizing it for subsequent analysis and processing. Additionally, it is specifically designed to facilitate seamless integration into 'shiny' applications, enhancing the interactive web application development experience. Built on the robust 'httr2' package, this version supersedes the previous 'httr'-based implementation. Recognizing the needs of large-scale data operations such as censuses, the package also incorporates features for parallel processing, enhancing its efficiency and scalability.
Authors:
SurveySolutionsAPIv2_0.1.2.tar.gz
SurveySolutionsAPIv2_0.1.2.zip(r-4.7-any)SurveySolutionsAPIv2_0.1.2.zip(r-4.6-any)SurveySolutionsAPIv2_0.1.2.zip(r-4.5-any)
SurveySolutionsAPIv2_0.1.2.tgz(r-4.6-any)SurveySolutionsAPIv2_0.1.2.tgz(r-4.5-any)
SurveySolutionsAPIv2_0.1.2.tar.gz(r-4.7-any)SurveySolutionsAPIv2_0.1.2.tar.gz(r-4.6-any)
SurveySolutionsAPIv2_0.1.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
SurveySolutionsAPIv2/json (API)
| # Install 'SurveySolutionsAPIv2' in R: |
| install.packages('SurveySolutionsAPIv2', repos = c('https://michael-cw.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/michael-cw/surveysolutionsapiv2/issues
Pkgdown/docs site:https://michael-cw.github.io
Last updated from:a878b1ff45. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 160 | ||
| source / vignettes | OK | 237 | ||
| linux-release | OK | 142 | ||
| macos-release | OK | 229 | ||
| macos-oldrel | OK | 180 | ||
| windows-devel | OK | 113 | ||
| windows-release | OK | 102 | ||
| windows-oldrel | OK | 114 | ||
| wasm-release | OK | 138 |
Exports:assignmentClassboxplot_summaryexportClassgetinfois.assignmentClassis.exportClassis.UserClasssummaryTablesuso_archUSRsuso_assignInterviewsuso_assignWorkspacesuso_cancelExportsuso_clear_keyssuso_commentInterviewsuso_createASSsuso_createCALEVsuso_createUSERsuso_createWorkspacesuso_delCALEVsuso_deleteInterviewsuso_deletemapsuso_deleteWorkspacesuso_enableWorkspacesuso_exportsuso_export_paradatasuso_get_api_keysuso_get_assignmentssuso_get_default_keysuso_get_statssuso_get_stats_interviewsuso_getAllAnswerInterviewsuso_getAllHistoryInterviewsuso_getAllInterviewQuestionnairesuso_getExportListsuso_getExportProcesssuso_getINTsuso_getINT_infosuso_getInterviewPDFsuso_getQuestDetailssuso_getQuestionsQuestionnairesuso_getStatsQuestionnairessuso_getSVsuso_getSV_infosuso_getUSRsuso_getWorkspacesuso_globalNoticesuso_keyssuso_mapassignsuso_mapinfosuso_mapreportsuso_mapuploadsuso_patchApproveInterviewsuso_patchRejectInterviewsuso_PwChecksuso_questCriticalityLevelsuso_questRecordAudiosuso_set_assignmentssuso_set_keysuso_set_maxpar_reqsuso_set_prog_messsuso_set_pwcheck_messsuso_set_workspacesuso_updateCALEVsuso_updateWorkspaceUserClass
Dependencies:askpassassertthatbase64encbitbit64bslibcachemclicliprcodetoolscommonmarkcpp11crayoncurldata.tabledigestdplyrfastmapfontawesomeforeachfsgenericsgluehmshtmltoolshttpuvhttr2iteratorsjquerylibjsonlitelaterlifecyclelubridatemagrittrmemoisemimeopensslotelpillarpkgconfigprettyunitsprogresspromisespurrrR6rappdirsRcppreadrrlangsassshinysourcetoolsstringistringrsusographqlsystibbletidyjsontidyrtidyselecttimechangetzdbutf8vctrsvroomwithrxtablezip
Field Operations, Users, and Assignments
Last update: 2026-10-02
Started: 2026-10-02
Data Export and Processing Pipelines
Introduction | 1. Supported Export Formats and Options | 2. Managing Export Processes (v2 API) | Listing Active and Historical Export Jobs | Checking Process Status | Canceling or Deleting an Export Job | 3. Automated End-to-End Export: suso_export() | Basic Usage | 4. Working with exportClass Objects | Retrieving Metadata with getinfo() | 5. Parallel Processing and Large-Scale Censuses
Last update: 2026-10-02
Started: 2026-10-02
Interview Monitoring, Paradata, and Quality Control
Introduction | 1. Tracking Interview Progress | Querying Interviews by Status | 2. Supervisory Actions and Audit | Leaving Comments on Question Responses | Rejecting and Approving Interviews | Downloading Interview PDF Transcripts | 3. Real-Time Question Statistics | 4. Paradata Processing | Exporting Paradata with suso_export_paradata() | Key QC Metrics from Paradata
Last update: 2026-10-02
Started: 2026-10-02
Questionnaires, Structure, and Codebooks
Introduction | 1. Extracting Questionnaire Structure | 2. Question Hierarchy and Metadata (q) | Inspecting Essential Columns | Static Text and Calculated Variables | 3. Skip Patterns and Routing Logic | 4. Validation Rules and Severity (val) | 5. Generating Codebooks (answers) | 6. Clean Flat Tables vs Raw JSON | 7. Questionnaire Settings: Audio & Criticality | Audio Audit Recording | Criticality Level
Last update: 2026-10-02
Started: 2026-10-02
Quickstart: Connecting and Exploring Your Server
Introduction | 1. Setting Up Credentials | Best Practice: Environment Variables | Initializing Credentials in R | Checking and Clearing Stored Credentials | 2. Testing Server Connectivity | 3. Discovering and Switching Workspaces | Listing All Workspaces | Switching Workspaces | 4. Discovering Deployed Questionnaires | 5. Global Package Options | Next Steps
Last update: 2026-10-02
Started: 2026-10-02
