Metadata-Version: 2.1
Name: cellex
Version: 1.0.0
Summary: Compute single-cell cell-type expression specificity
Home-page: https://github.com/perslab/CELLEX
Author: Tobias O. Stannius
License: UNKNOWN
Description: # CELLEX
        CELLEX (CELL-type EXpression-specificity) is a tool for computing cell-type Expression Specificity (ES) profiles. It employs a "wisdom of the crowd"-approach by integrating multiple ES metrics, thus combining complementary cell-type ES profiles, to capture multiple aspects of ES and obtain improved robustness.
        
        
        
        ## Contents
        * [Quick start](#Quick-start)
        * [Documentation](docs/)
        
        
        # Quick start
        This brief tutorial showcases the core features of CELLEX.
        
        ## Setup
        Download this repository and place it in the same directory as the script or Jupyter Notebook you wish to use CELLEX with.
        
        ## Import modules
        ```python
        import numpy as np # needed for formatting data for this tutorial
        import pandas as pd # needed for formatting data for this tutorial
        import CELLEX.cellex as cellex # needed when importing directly from this repo
        ```
        
        ## Load input data and metadata
        ```python
        data = pd.read_csv("./data.csv", index_col=0)
        metadata = pd.read_csv("./metadata.csv", index_col=0)
        ```
        
        ### Data format
        Data may consist of UMI counts (integer) for each **gene** and **cell**.
        
        |               | cell_1                | ... | cell_9                 |
        |---------------|-----------------------|-----|------------------------|
        | gene_x        | 0                     | ... | 4                      |
        | ...           | ...                   | ... | ...                    |
        | gene_z        | 3                     | ... | 1                      |
        
        Shape: *m* genes by *n* cells.
        
        ### Metadata format
        Metadata should consist of cell id's and matching annotation (string).
        
        | cell_id                | cell_type |
        |------------------------|-----------|
        | cell_1                 | type_A    |
        | ...                    | ...       |
        | cell_9                 | type_C    |
        
        Shape: *n* cells by 2.
        
        ## Create ESObject and compute ESmu
        
        ```python
        eso = cellex.ESObject(df=data, annotation=metadata, verbose=True)
        
        eso.compute(verbose=True)
        ```
        
        ## Save result(s)
        Only saves ESmu by default. The ESmu specificity scores may be used directly with **[CELLECT](https://github.com/perslab/CELLECT)**.
        
        ```python
        eso.save(verbose=True)
        ```
        
        ### Output format
        Output consist of Expression Specificity Weights (float) for each **gene** and **cell-type**. ESmu values lie in the range [0,1].
        
        |               | type_A                | ... | type_C                 |
        |---------------|-----------------------|-----|------------------------|
        | gene_x        | 0.0                   | ... | 0.9                    |
        | ...           | ...                   | ... | ...                    |
        | gene_z        | 0.1                   | ... | 0.2                    |
        
        Shape: *m* genes by *x* unique annotations. N.B. a number of genes may be removed during preprocessing.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
