Welcome to SMARTER-backend’s documentation!
This documentation describes how to install and interact with the SMARTER database backend. Briefly, the SMARTER database created and maintained with the SMARTER-database project is made accessible to SMARTER partners using this API. This API is the same used by the SMARTER-frontend in order to access and browse SMARTER data using a web browser.
If you are partner of the SMARTER project, and member of WP4 group, you should have received the credentials to access the smarter API. If you aren’t a SMARTER partner, you cannot access to SMARTER data using API, however this API with the WEB frontend (and the genotypes) will be made available to the public at the end of the project. If you are member of WP4 SMARTER project but you don’t have the credentials yet, please send an email to the WP coordinators.
SMARTER-backend is a flask-API application developed on top of a MongoDB instance. The application works inside Docker containers managed with docker-compose. SMARTER WP4 users who need to subset or retrieve genotypes from the entire genotypes dataset need to retrieve variants and samples according their needs, in order to filter out the data they need using a PLINK command line.
Documentation is organized as following: in Introduction we describe what SMARTER-backend is and we provide general information. In Backend installation we describe how to install a local instance of SMARTER-backend. Then in Accessing SMARTER-backend we describe how to programmatically access to data or how to inspect data using applications like Postman or Talend Api Tester google-chrome extension.