Git Product home page Git Product logo

cellex's Introduction

PyPI version shields.io

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.

CELLEX_overview

Contents

Documentation

The documentation for CELLEX can be accessed in the following ways:

We are continually updating the documentation for CELLEX. If some information is missing, please submit your request or question via our issue tracker.

Quick start

This brief tutorial showcases the core features of CELLEX.

TL;DR

import numpy as np
import pandas as pd
import cellex

data = pd.read_csv("./data.csv", index_col=0)
metadata = pd.read_csv("./metadata.csv", index_col=0)

eso = cellex.ESObject(data=data, annotation=metadata, verbose=True)
eso.compute(verbose=True)
eso.results["esmu"].to_csv("mydataset.esmu.csv.gz")

Walkthrough

Setup

Option A: Install the latest release from PyPi

pip install cellex

Option B: Install the development version from this repo

Clone the development repo and install from source using pip. The development version may contain bug fixes that have not been released, as well as experimental features.

git clone https://github.com/perslab/CELLEX.git --branch develop --single-branch
cd CELLEX
pip install -e .

Import modules

import numpy as np # needed for formatting data for this tutorial
import pandas as pd # needed for formatting data for this tutorial
import cellex

Load input data and metadata

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 unique 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

eso = cellex.ESObject(data=data, annotation=metadata, verbose=True)

eso.compute(verbose=True)

View Expression Specificity scores

All results are accessible via the results attribute of the ESObject.

eso.results["esmu"]

Save result(s)

Pro-tip: Using CELLEX with CELLECT

The ESmu scores may be used with CELLECT. CELLECT requires that genes are in the Human Ensembl Gene ID format. CELLEX provides a simple renaming utility for this purpose:

cellex.utils.mapping.mouse_ens_to_human_ens(eso.results["esmu"], drop_unmapped=True, verbose=True)

Save ESmu

eso.results["esmu"].to_csv("mydataset.esmu.csv.gz")

Save all or specific results

eso.save_as_csv(keys=["all"], 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.

Tutorials

Various tutorials and walkthroughs will be made available here, while the Wiki is in the making. These Jupyter Notebooks cover everything from downloading CELLEX and data to analysis and plotting.

About

Developers

  • Tobias Overlund Stannius (University of Copenhagen) @TobiasStannius
  • Pascal Nordgren Timshel (University of Copenhagen) @ptimshel

Contact

Please create an issue in this repo, if you encounter any problems using CELLEX. Alternatively, you may write an email to timshel(at)sund.ku.dk

References

If you find CELLEX useful for your research, please consider citing: Timshel (eLife, 2020): Genetic mapping of etiologic brain cell types for obesity

cellex's People

Contributors

tstannius avatar pascaltimshel avatar pvtodorov avatar liubovpashkova avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.