Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 34 Next »

OpenCGA RESTful Web Services

HGVA is powered by the Open Computational Genomic Analysis (OpenCGA) project. OpenCGA implements an extensive API that enables numerous operations over metadata, samples and genomic data. The whole API specification can be accessed at:

http://bioinfodev.hpc.cam.ac.uk/hgva-1.0/webservices

A description of the API and URLs design can be found at the OpenCGA RESTful Web Services documentation.

The tutorial Using RESTful Web Services URL shows practical examples on how to directly query the RESTful API. It focuses on those end points of the API which are of more interest for HGVA users, giving examples of their use and pin pointing certain peculiarities of the parameters for HGVA. Data is hierarchically organised in Projects and Studies. Please, in order to understand the API behaviour, have a look at Datasets and Studies in order to first how data is organized: Projects, Studies and Cohorts . For details on the query parameters, please refer to the Swagger documentation linked above.

Clients

Likewise, a number of client libraries are provided which make intensive use of the OpenCGA RESTful API. They provide fast programmatic access for genome-scale data analysis, therefore discouraging massive downloads of data to local computers. Currently supported languages include Python, Java and JavaScript. A similar design has been used in all of them in order to facilitate their use, external contributions and maintenance. Again, all of them provide an exhaustive API for accessing the whole OpenCGA RESTful API. Please, refer to the corresponding Tutorials to find details on how to download, install, configure the libraries as well as practical examples on how to use the methods which are of particular interest for HGVA users.

Java


Python (pyCGA)

pyCGA is the Python client library for OpenCGA RESTful Web Services, all the web services are accessible through this client, and it offers a quick way to query OpenCGA projects programmatically from custom scripts. pyCGA code is open source. A public issue tracker enables users to provide comments and contributions:

https://github.com/...

Please, refer to the tutorial Using the Python REST client in order to get detailed instructions for installing and configuring it, as well as a list of the methods which are of more interest for HGVA users and practical examples on how to use them.

JavaScript client

OpencgaClient is the Javascript client library for OpenCGA RESTful Web Services, all the web services are accessible through this client, and it offers a quick way to query OpenCGA projects through web interface. This is available at OpenCB JSorolla.




Table of Contents:

  • No labels