Package documentation

infx

API access to the InfectX data repository

List openBIS objects

Enumerate openBIS for objects used to organize datasets

list_datasets() list_dataset_ids() list_references() list_dataset_types()

List datasets and dataset reference objects

list_experiments() list_experiment_ids() list_experiment_types() as_experiment_id()

List experiments

list_material() material_id() list_material_types() as_screening_mat_id() as_generic_mat_id() extract_well_material()

List materials

list_plates() list_plate_metadata() plate_id() as_plate_id() list_wells() well_id() as_well_id() well_pos()

List plates and wells

list_projects()

List projects

list_samples() list_sample_types()

List samples and sample types

Search for openBIS objects

Query openBIS for data set, experiment, material and sample objects

search_openbis() search_criteria() search_sub_criteria() property_clause() any_property_clause() any_field_clause() attribute_clause() time_attribute_clause() list_property_types()

Assemble and execute openBIS search queries

List/download openBIS resources

List and fetch files, images and feature data

list_features() list_feature_codes() fetch_features()

List and download feature data

list_files() fetch_files() read_mat_files()

List and download files

fetch_images() list_image_metadata()

List image meta data and download images

list_download_urls() list_datastores() list_datastore_urls()

List data store servers and urls

JSON objects in R

Create, display and modify JSON objects returned by openBIS

print(<json_class>) `[`(<json_class>) c(<json_class>) rep(<json_class>) print(<json_vec>) `[`(<json_vec>) `[<-`(<json_vec>) `[[`(<json_vec>) `[[<-`(<json_vec>) c(<json_vec>) rep(<json_vec>) as_list()

Base generics for JSON objects

json_class() as_json_class() as.json_class() rm_json_class() as.list(<json_class>) is_json_class() is.json_class() check_json_class()

Create and validate JSON class objects

has_fields() get_field() has_subclass() get_subclass() remove_null()

JSON class utilities

json_vec() as_json_vec() as.json_vec() as.list(<json_vec>) is_json_vec() is.json_vec() has_common_subclass()

Construct and validate JSON object vectors

Utility functions

Assemble JSON-RPC request and issue a POST request to openBIS; parse results; login/logout functionality; helpers for reading downloaded files

make_requests() make_request() do_requests_serial() do_requests_parallel() process_json() resolve_references()

Construct and issue JSON-RPC requests

login_openbis() logout_openbis() is_token_valid()

Create and destroy a login token

api_url() docs_link()

OpenBIS urls