-
Notifications
You must be signed in to change notification settings - Fork 1
Home
The Inter-Resource Communication Tool - Resource Interface (IRCT-RI) allows for a variety of services to be called by the IRCT. In this repository we include a few example of resource interfaces that are currently being used as part of the BD2K HMS PIC-SURE Center of Excellence.
You can learn more about the BD2K HMS PIC-SURE Center of Excellence at: http://www.pic-sure.org
The Inter-Resource Communication Tool (IRCT) is an open-source project that is being developed as part of as part of NIH BD2K PIC-SURE Center of Excellence. It fosters the incorporation of multiple heterogeneous patient level clinical, omics, and environmental datasets. It allows for a user to create queries across multiple different resources of varying types with one interface. The BD2K PIC-SURE RESTful API implementation is called Inter Resource Communication Tool (IRCT).
You can learn more about the BD2K PIC-SURE RESTful API at: http://bd2k-picsure.hms.harvard.edu/
A resource is any system that an IRCT instance can run a query or process. While a resource interfaces is the way that an IRCT instance communicates with that resource. Each resource uses a resource interface to communicate with a service. Multiple resources can use the same type of resource interface to communicate with different systems.
The IRCT is a 'resource driven' API which allows for resources to describe what they are and what they can do. Each resource may implement as many or as few of the available query clauses, or processes that a resource interface provides. Resources are added to an IRCT instances by an administrator running a SQL script and resetting the IRCT so the new resources are made available.
An IRCT query is a way for a user to interact with any number of different resources to get data of a specific type. A query consists of clauses of which there are four different types; Select, Where, Sort, and Join.
An IRCT process is similar to an IRCT query in that it is a generic way to ask a remote resource to perform a specific task (e.g. Annotation of a result with ExAC information).
As described above the IRCT is a 'resource driven' API that allows resources to define how they can be used.
More information about creating, and installing your own resource interface will be coming soon.