from abc import ABCMeta, abstractmethod import fastobo import fsspec from backend.common.errors import OntologyLoadFailure, DisabledFeatureError from backend.common.utils.type_conversion_utils import get_schema_type_hint_of_array class Annotations(metaclass=ABCMeta): """ baseclass for annotations, including ontologies and genesets""" """ our default ontology is the PURL for the Cell Ontology. See http://www.obofoundry.org/ontology/cl.html """ DefaultOnotology = "http://purl.obolibrary.org/obo/cl.obo" def __init__(self, config={}): self.ontology_data = None self.config = config def user_annotations_enabled(self): return self.config.get("user-annotations", False) def gene_sets_save_enabled(self): return self.config.get("genesets-save", False) def check_user_annotations_enabled(self): if not self.user_annotations_enabled(): raise DisabledFeatureError("User annotations are disabled.") def check_gene_sets_save_enabled(self): if not self.gene_sets_save_enabled(): raise DisabledFeatureError("User genesets save is disabled.") def load_ontology(self, path): """Load and parse ontologies - currently support OBO files only.""" if path is None: path = self.DefaultOnotology try: with fsspec.open(path) as f: obo = fastobo.iter(f) terms = filter(lambda stanza: type(stanza) is fastobo.term.TermFrame, obo) names = [tag.name for term in terms for tag in term if type(tag) is fastobo.term.NameClause] self.ontology_data = names except FileNotFoundError as e: raise OntologyLoadFailure("Unable to find OBO ontology path") from e except SyntaxError as e: raise OntologyLoadFailure("Syntax error loading OBO ontology") from e except Exception as e: raise OntologyLoadFailure("Error loading OBO file") from e def get_schema(self, data_adaptor): schema = [] labels = self.read_labels(data_adaptor) if labels is not None and not labels.empty: for col in labels.columns: col_schema = dict(name=col, writable=True) col_schema.update(get_schema_type_hint_of_array(labels[col])) schema.append(col_schema) return schema @abstractmethod def set_collection(self, name): """set or create a new annotation collection""" pass @abstractmethod def read_labels(self, data_adaptor): """Return the labels as a pandas.DataFrame""" pass @abstractmethod def write_labels(self, df, data_adaptor): """Write the labels (df) to a persistent storage such that it can later be read""" pass @abstractmethod def read_gene_sets(self, data_adaptor): """Return the genesets from persistent storage """ pass @abstractmethod def write_gene_sets(self, gs, data_adaptor): """Write the genesets (gs) to a persistent storage such that it can later be read""" pass @abstractmethod def update_parameters(self, parameters, data_adaptor): """Update configuration parameters that describe information about the annotations feature""" pass Genesets_Header = [ "gene_set_name", "gene_set_description", "gene_symbol", "gene_description", ] @staticmethod def gene_sets_to_csv(genesets): """ Convert the internal genesets format (returned by read_gene_set) into the simple Tidy CSV. """ from io import StringIO import csv if isinstance(genesets, dict): genesets = genesets.values() with StringIO() as sio: writer = csv.writer(sio, dialect='excel') writer.writerow(Annotations.Genesets_Header) for geneset in genesets: # genes may be empty, in which case we skip the geneset entirely genes = geneset["genes"] if not genes: writer.writerow([geneset["geneset_name"], geneset.get("geneset_description", ""), "", ""]) else: writer.writerows( [ [ geneset["geneset_name"], geneset.get("geneset_description", ""), gene["gene_symbol"], gene.get("gene_description", ""), ] for gene in genes ] ) return sio.getvalue() @staticmethod def gene_sets_to_response(genesets): """ Convert the internal genesets format (returned by read_gene_set) into the dict expected by the JSON REST API """ return list(genesets.values())