Package index • jatosr

Credentials and connection

Store the API token in the credential store of the operating system, find out where a token is coming from, and check it against the server.

jatos_connection(): Connect to a JATOS server
jatos_set_credentials(): Store JATOS credentials in the system credential store
jatos_remove_credentials(): Remove JATOS credentials from the credential store
jatos_credentials_sitrep(): Report where each token is coming from
jatos_has_credentials(): Are JATOS credentials available?
jatos_list_profiles(): List the credential profiles on this machine
jatos_token_info(): Check the token and show its metadata

Study structure

Studies, components, batches and groups the token can see.

jatos_studies(): List the studies a token can see
jatos_study(): Properties of one study
jatos_components(): Components of a study
jatos_batches(): Batches of a study
jatos_batch(): Properties of one batch
jatos_groups(): Groups of a batch (group studies only)
jatos_study_log(): Recent entries of a study log

Result metadata

One row per component result from the server or a local cache; one row per study result on request; filters and the URL query parameters as columns.

jatos_results_metadata(): Result metadata, one row per component result
jatos_flatten_metadata(): Flatten a /results/metadata answer into a tibble
jatos_study_results(): One row per study result
jatos_filter_metadata(): Keep the study results that belong in a dataset
jatos_url_query(): Widen the URL query parameters into columns
jatos_read_metadata(): Rebuild result metadata from a local cache
jatos_cache_status(): Summarise a local cache batch by batch

Result download, reading and export

Fetch result files into a local cache incrementally, pull single fields out of them, read jsPsych JSON into one tibble with the metadata joined, and save it; or do all of that in one call.

jatos_export_results(): Fetch, read and save the trials of a study in one call
jatos_download_results(): Download result data into a local cache
jatos_extract_fields(): Extract scalar fields from result files without parsing them
jatos_read_json(): Read one jsPsych result file
jatos_read_results(): Read the result files of a metadata tibble into one tibble
jatos_write_results(): Write a trials tibble to disk
jatos_write_raw(): Copy the raw result files, one per participant

Uploaded files, archives and import

Files participants uploaded during a run, fetched with the same incremental rule; the study archive (.jzip) that reproduces the experiment; the results archive as the server builds it; and the import of such a zip into a cache.

jatos_result_files(): Files uploaded during a run, one row per file
jatos_download_files(): Download the files uploaded during runs into the cache
jatos_export_study(): Download the study archive
jatos_export_archive(): Download the results archive as the server produces it
jatos_import_results(): Import a JATOS results zip into the cache

Study codes

Generate, inspect, activate and deactivate study codes, and build the run URLs participants open.

jatos_create_study_codes(): Generate study codes for a batch
jatos_study_code(): Properties of study codes
jatos_activate_study_code() jatos_deactivate_study_code(): Activate or deactivate study codes
jatos_study_links(): Run URLs for study codes

Package

jatosr jatosr-package: jatosr: Download and Manage 'JATOS' Study Data