fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-09-19 02:48:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fleshed out documentation and params for methods

Browse Source 
Given feedback from designing rest v2.0
This commit is contained in:
Charlotte Weaver
2018-06-05 16:05:04 -07:00
parent e84793ede9
commit 9cf300caeb
1 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
backend/app/driver/driver.py
View File

@@ -27,31 +27,42 @@ class CXGDriver(metaclass=abc.ABCMeta):
"""
Filter cells from data and return a subset of the data
:param filter:
:return: iterator through cells
:return: iterator through cell ids
"""
pass
# Should this return the order of metadata fields as the first value?
@abstractmethod
def metadata_ranges(self, cells_iterator):
def metadata(self, cells_iterator, fields=None):
"""
Generator for metadata. Gets the metadata values cell by cell and returns all value
or only certain values if names is not None
:param cells_iterator: from filter cells, iterator for cellids
:param fields: list of keys for metadata to return, returns all metadata values if not set.
:return: Iterator for cellid + list of cells metadata values ex. [cell-id, val1, val2, val3]
"""
pass
@abstractmethod
def metadata(self, cells_iterator):
"""
"""
pass
@abstractmethod
def create_graph(self, cells_iterator):
"""
Computes a n-d layout for cells through dimensionality reduction.
:param cells_iterator: from filter cells, iterator for cellids
:return: Iterator for [cellid-1, pos1, pos2], [cellid-2, pos1, pos2]
"""
pass
@abstractmethod
def diffexp(self, cells_iterator):
def diffexp(self, cells_iterator_1, cells_iterator_2):
"""
Computes the top differentially expressed genes between two clusters
:param cells_iterator_1: First set of cell ids
:param cells_iterator_2: Second set of cell ids
:return: Up in the air: I recommend [gene name, mean_expression_cells1, mean_expression_cells2, average_difference, statistic_value]
"""
pass