Fleshed out documentation and params for methods

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
+19 -8
View File
@@ -27,31 +27,42 @@ class CXGDriver(metaclass=abc.ABCMeta):
""" """
Filter cells from data and return a subset of the data Filter cells from data and return a subset of the data
:param filter: :param filter:
:return: iterator through cells :return: iterator through cell ids
""" """
pass pass
# Should this return the order of metadata fields as the first value?
@abstractmethod @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 pass
@abstractmethod
def metadata(self, cells_iterator):
"""
"""
pass
@abstractmethod @abstractmethod
def create_graph(self, cells_iterator): 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 pass
@abstractmethod @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 pass