Client for the HuBMAP Cells API
Project description
hubmap-api-py-client
Python client for the HuBMAP Cells API;
See also: hubmap-api-js-client
.
Contributors start here.
Usage
Install from pypi:
pip install hubmap-api-py-client
Find cells with different criteria, and intersect resulting sets:
>>> from hubmap_api_py_client import Client
>>> client = Client('https://cells.dev.hubmapconsortium.org/api/')
>>> [m for m in dir(client) if m.startswith('select_')]
['select_cells', 'select_clusters', 'select_datasets', 'select_genes', 'select_organs', 'select_proteins']
>>> cells_with_vim = client.select_cells(where='gene', has=['VIM > 0.5'], genomic_modality='rna')
>>> assert len(cells_with_vim) > 0
# Select cells from the datasets with the following UUIDs:
>>> dataset_a_uuid = '68159e4bd6a2cea1cd66e8f3050cfcb7'
>>> dataset_b_uuid = 'e8d642084fc5ec8b5d348ebab96a4b22'
>>> cells_in_a_len = len(client.select_cells(where='dataset', has=[dataset_a_uuid]))
>>> cells_in_b_len = len(client.select_cells(where='dataset', has=[dataset_b_uuid]))
>>> cells_in_datasets = client.select_cells(where='dataset', has=[dataset_a_uuid, dataset_b_uuid])
>>> cells_in_datasets_len = len(cells_in_datasets)
>>> assert cells_in_datasets_len > 0
>>> assert cells_in_datasets_len == cells_in_a_len + cells_in_b_len
# Combine criteria with intersection:
>>> cells_with_vim_in_datasets = cells_with_vim & cells_in_datasets
# Get a list; should run quickly:
>>> cell_list = cells_with_vim_in_datasets.get_list(10)
>>> assert len(cell_list) == 10
>>> assert cell_list[0].keys() == {'cell_id', 'modality', 'dataset', 'organ', 'clusters', 'protein_mean', 'protein_total', 'protein_covar'}
Only some types of objects can be retrieved from other types of objects:
where=... |
None | cell |
cluster |
dataset |
gene |
organ |
protein |
---|---|---|---|---|---|---|---|
select_cells() |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
select_clusters() |
✓ | ✓ | ✓ | ✓ ✩ | ✩ | ✩ | |
select_datasets() |
✓ | ✓ | ✓ | ✓ | ✶ | ||
select_genes() |
✓ | ✓ ✩ | ✓ | ✓ ✩ | ✩ | ||
select_organs() |
✓ | ✓ | ✩ | ✶ | ✓ ✩ | ✓ | ✩ |
select_proteins() |
✓ | ✩ | ✩ | ✩ |
- "✓" = Supported by Cells API, and this client.
- "✶" = Supported by Entities API; support in this client is on the roadmap.
- "✩" = Possible connection to ASCT-B (Anatomical Structures / Cell Types / Biomarkers)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hubmap-api-py-client-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09eea17be42f56f5e9bb01ea368286d2aa2659a1d3a35d3a5a5f772100ce5a83 |
|
MD5 | 3ad9f8598c9ff9497b8009c404b8c497 |
|
BLAKE2b-256 | 7a237c407826b3a29c1563f9e40b8679e5e4e7d74fd7b3a08b4bf62bb1b3f38f |
Close
Hashes for hubmap_api_py_client-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fa9d65a835eb1eddfd4a19826a67e507df4fec6a3f370bc1ede64173b1bde6c |
|
MD5 | 6c9178281524ff1dec0a908e5910897f |
|
BLAKE2b-256 | 832d7351b17e0e3671e2c5a2668325269f12d7241bef23f35f7a82fc670b28af |