interview_stats: Get information about an interview

In l2nguyen/susoapir: API wrapper for Survey Solutions

Description

interview_stats gets information about an interview, including:

• Interview key

• Number of unanswered questions

• Number of answered questions

• Number of questions with errors

• Number of questions with comments

• Current status of interview

• Number of rejections by HQ

• Number of rejections by Supervisor

• Assignment Id that the interview was generated from

Usage

interview_stats(ids = NULL, server = NULL, user = NULL, password = NULL)

Arguments

ids	Interview Id. The interview Id can have dashes or not. This accepts a vector of interview Ids. In exported data, this will be the variable interview__id.
server	Prefix for the survey server. It is whatever comes before mysurvey.solutions: [prefix].mysurvey.solutions.
user	Username for the API user on the server.
password	Password for the API user on the server.

Value

A data frame with statistics on the interviews associated with the interview IDs provided.

Examples

## Not run: 
## Vector of IDs to get stats for
int_ids <- c("5970be83582840df972082c578816dba", "47748cf7aa0641a692a1fffc508a435c",
"61ef820e5bac466e829355abe42bc137", "63053caafa424a8d993cc22be2c9baf0")

## Get statistics for those interviews
interview_stats(ids = int_ids, server = "lfs2018",
user = "APIuser2018", password = "SafePassword123")

## End(Not run)

l2nguyen/susoapir documentation built on Jan. 14, 2020, 2:29 p.m.