This repository contains scripts in the python, R, and curl command to access mapMECFS data via the API.
The mapMECFS website serves as the omics data sharing portal for Myalgic Encephalomyelitis/Chronic Fatigue Syndrome (ME/CFS) research, created as part of the NIH funded ME/CFS Network. This website enables researchers to gain a broader view of ME/CFS by:
- Bringing together the data that researchers have collected across the multiple systems affected by ME/CFS
- Providing a dynamic navigation portal to search across these domains
- Facilitating the integration of complementary data types to offer a new, more complete picture of the disorder
mapMECFS is available to all researchers at https://www.mapmecfs.org/.
This repository provides detailed documentation of the mapMECFS API to access and search data stored on mapMECFS. Documentation is provided in the curl, python, and R languages. The mapMECFS API is built on the CKAN API, therefore further documentation of available calls is available in the CKAN API guide
Examples in each programming languages (R, python, and curl) are given for the following activities on mapMECFS.
- List of datasets on mapMECFS
- List of datasets and their metadata on mapMECFS
- Retrieve a list of all tags used on mapMECFS
- Retrieve metadata for a particular dataset on mapMECFS
- Search a particular tag used on mapMECFS
- Search data on mapMECFS according to a specific query
- Create a dataset and upload a resource
All API requests to mapMECFS require a user specific API key. Follow these simple steps to retrieve your API key.
- After logging in, authorized users will be able to navigate to their user account page by finding the link near the top right corner.
- On your user account page, API token can be generated by clicking on the 'API Tokens' button and providing a novel name for the token. Once the token is generated do not forget to save the token in a safe location to use it with API calls.
mapMECFS has been implemented using the CKAN framework (https://ckan.org/). Our custom created plugins for advanced authentication, search terms, and summary statistics are publicly available.
Please contact the mapMECFS support team (mapmecfs@rti.org) with any bug reports, site assistance, and feature requests.
The mapMECFS manuscript is available at https://translational-medicine.biomedcentral.com/articles/10.1186/s12967-021-03127-3