Package index • eatPrepTBA

Connecting to the API

Functions and classes for communicating with the IQB Testcenter API

Functions for access

login_studio(): Generate a LoginStudio object for the IQB Studio Lite
login_testcenter(): Generate a LoginTestcenter object for the IQB Testcenter
access_workspace(): Access a workspace

Classes

Login-class: Login credentials
LoginStudio-class: Login credentials for IQB Studio
LoginTestcenter-class: Login credentials for IQB Testcenter
Workspace-class: Workspace access
WorkspaceStudio-class: Workspace access for IQB Studio
WorkspaceTestcenter-class: Workspace access for IQB Testcenter

Preparing unit metadata and coding schemes

Functions to prepare unit data from IQB Studio or Testcenter

List resources on IQB Studio

list_units(): List unit files
list_groups(): List groups

List resources on IQB Testcenter

list_files(): List files
list_resources(): List unit resource files
list_units(): List unit files
list_booklets(): List booklet files
list_testtakers(): List testtakers files
list_system_checks(): List system check files

Handle units and workspaces on IQB Studio

get_units(): Get multiple units with resources

Retrieve responses from IQB Testcenter

get_responses(): Get responses directly from Testcenter
read_responses(): Reads responses files
prepare_responses() experimental: Prepares responses
get_system_checks(): Get system check reports
read_system_checks(): Reads and prepares system check file
get_design(): Recovers a design from IQB Testcenter
get_booklets(): Get a booklets from IQB Testcenter
read_booklet(): Reads a booklet XML
get_testtakers(): Get a testtakers from IQB Testcenter
read_testtakers(): Reads a testtakers XML
get_results(): Get results
get_logs(): Get logs
read_logs(): Reads log files
prepare_logs() experimental: Prepares logs
get_reviews(): Get reviews
compute_sizes(): Computes resource sizes for Testcenter instances

Functions for units

add_metadata(): Add metadata to units
add_coding_scheme(): Adds prepared coding scheme to units
extract_metadata(): Extract metadata profiles from units with metadata

Managing studies

Functions to check units, prepare material for administration and coding

Prepare studies on IQB Studio

get_units(): Get multiple units with resources
get_states(): Get states
get_settings(): Get workspace settings
get_coding_report(): Get coding report
prepare_coding_scheme(): Prepares a readable version of a coding scheme of one unit
download_codebook(): Download codebook
prepare_codebook(): Prepares a rectangular codebook
download_units(): Download units
add_groups(): Add workspace groups for a Studio workspace

Prepare studies on IQB Testcenter

generate_testtakers(): Generates testtakers XML from unit information
generate_booklet() deprecated: Generates booklets XML from unit information
generate_booklets(): Generates booklet XMLs from booklet, testlet, and unit information
upload_file(): Upload file

Code responses and work with coded responses and logs from IQB Testcenter

code_responses(): Code unit responses with coding schemes
complete_design(): Complete design with coded responses
estimate_unit_times() experimental: Estimates stay times from log data
evaluate_psychometrics(): Evaluates frequencies and discrimination parameters of codes and categories