PIC-SURE API Documentation

How to get started with PIC-SURE and the common endpoints you can use to query any resource registered with PIC-SURE

The PIC-SURE v2 API is a meta-API used to host any number of resources exposed through a unified set of generalized operations.

PIC-SURE Repositories:

• PIC-SURE API: This is the repository for version 2+ of the PIC-SURE API.

• PIC-SURE Wiki: This is the wiki page for version 2+ of the PIC-SURE API.

• BioData Catalyst PIC-SURE: This is the repository for the BioData Catalyst environment of PIC-SURE.

• PIC-SURE-ALL-IN-ONE: This is the repository for PIC-SURE-ALL-IN-ONE.

Additional PIC-SURE Links:

• DCPPC Presentation on PIC-SURE as a meta-API

• Avillachlab-Jenkins Repository: A link to the Avillach Lab Jenkins repository.

• Avillachlab-Jenkins Dev Release Control: A repository for Avillach Lab Jenkins development release control.

Client Libraries

The following are the collected client libraries for the entire PIC-SURE project.

• R Client Library

• Python Client Library

PIC-SURE User Interface

The PIC-SURE User Interface acts as a visual aid for running normal queries of resources through PIC-SURE.

PIC-SURE User Interface Repositories:

• PIC-SURE HPDS UI: The main High Performance Data Store (HPDS) UI repository.

Additional PIC-SURE User Interface Links:

• PIC-SURE UI Flow: Links to a google drawing of the PIC-SURE UI flow.

PIC-SURE Auth Micro-App (PSAMA)

The PSAMA component of the PIC-SURE ecosystem authorizes and authenticates all actions taken within PIC-SURE.

PSAMA Repos:

• PIC-SURE Auth MicroApp Repository

Additional PSAMA Links:

• PSAMA Core Logic: This is where the core of the PSAMA application is stored in GitHub

High Performance Data Store (HPDS)

HPDS is a datastore designed to work with the PIC-SURE meta-API. It grants researchers fast, dependable access to static datasets and the ability to produce statistics-ready dataframes filtered on any variable they choose at any time.

HPDS Repositories:

• PIC-SURE HPDS: The main HPDS repository.

• PIC-SURE HPDS Python Client: Python client library to run queries against a PIC-SURE HPDS resource.

• PIC-SURE HPDS R Client: R client library to run queries against a PIC-SURE HPDS resource.

• PIC-SURE HPDS UI: The main HPDS UI repository.

• HPDS Annotation: This repository describes steps to prepare and annotate VCF files for loading into HPDS.