{ "info": { "author": "Tobias O. Stannius", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# CELLEX\nCELLEX (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.\n\n\n\n## Contents\n* [Quick start](#Quick-start)\n* [Documentation](docs/)\n\n\n# Quick start\nThis brief tutorial showcases the core features of CELLEX.\n\n## Setup\nDownload this repository and place it in the same directory as the script or Jupyter Notebook you wish to use CELLEX with.\n\n## Import modules\n```python\nimport numpy as np # needed for formatting data for this tutorial\nimport pandas as pd # needed for formatting data for this tutorial\nimport CELLEX.cellex as cellex # needed when importing directly from this repo\n```\n\n## Load input data and metadata\n```python\ndata = pd.read_csv(\"./data.csv\", index_col=0)\nmetadata = pd.read_csv(\"./metadata.csv\", index_col=0)\n```\n\n### Data format\nData may consist of UMI counts (integer) for each **gene** and **cell**.\n\n| | cell_1 | ... | cell_9 |\n|---------------|-----------------------|-----|------------------------|\n| gene_x | 0 | ... | 4 |\n| ... | ... | ... | ... |\n| gene_z | 3 | ... | 1 |\n\nShape: *m* genes by *n* cells.\n\n### Metadata format\nMetadata should consist of cell id's and matching annotation (string).\n\n| cell_id | cell_type |\n|------------------------|-----------|\n| cell_1 | type_A |\n| ... | ... |\n| cell_9 | type_C |\n\nShape: *n* cells by 2.\n\n## Create ESObject and compute ESmu\n\n```python\neso = cellex.ESObject(df=data, annotation=metadata, verbose=True)\n\neso.compute(verbose=True)\n```\n\n## Save result(s)\nOnly saves ESmu by default. The ESmu specificity scores may be used directly with **[CELLECT](https://github.com/perslab/CELLECT)**.\n\n```python\neso.save(verbose=True)\n```\n\n### Output format\nOutput consist of Expression Specificity Weights (float) for each **gene** and **cell-type**. ESmu values lie in the range [0,1].\n\n| | type_A | ... | type_C |\n|---------------|-----------------------|-----|------------------------|\n| gene_x | 0.0 | ... | 0.9 |\n| ... | ... | ... | ... |\n| gene_z | 0.1 | ... | 0.2 |\n\nShape: *m* genes by *x* unique annotations. N.B. a number of genes may be removed during preprocessing.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/perslab/CELLEX", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "cellex", "package_url": "https://pypi.org/project/cellex/", "platform": "", "project_url": "https://pypi.org/project/cellex/", "project_urls": { "Homepage": "https://github.com/perslab/CELLEX" }, "release_url": "https://pypi.org/project/cellex/1.0.0/", "requires_dist": [ "plotnine (==0.5.1)", "numpy (==1.17.0)", "scipy (==1.3.1)", "pandas (==0.25.0)", "setuptools (==41.0.1)", "h5py (==2.9.0)", "setuptools-scm (==3.3.3)" ], "requires_python": "", "summary": "Compute single-cell cell-type expression specificity", "version": "1.0.0" }, "last_serial": 5880686, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "747b4dcaff2589063684e53e247cacff", "sha256": "15144c6723ab6327d96a6f4f434eb6c4a9ea347ca7b8f032ba307b3ffab917ae" }, "downloads": -1, "filename": "cellex-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "747b4dcaff2589063684e53e247cacff", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 41266, "upload_time": "2019-09-24T16:04:25", "url": "https://files.pythonhosted.org/packages/b7/16/af3ed51a3d0be39211e9b72579023aa9f871e5338de073ea7698155904e2/cellex-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc89f10da51a72e08333369d6c78333a", "sha256": "45eecfe45dcb164208b489bdcb54cffe989cee6f6b2805934a333640fd017f0e" }, "downloads": -1, "filename": "cellex-1.0.0.tar.gz", "has_sig": false, "md5_digest": "cc89f10da51a72e08333369d6c78333a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6220283, "upload_time": "2019-09-24T16:04:29", "url": "https://files.pythonhosted.org/packages/96/7f/f249cb96898b68c384490125bf900ce4fd14b000c0b5608e70932790ffcf/cellex-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "747b4dcaff2589063684e53e247cacff", "sha256": "15144c6723ab6327d96a6f4f434eb6c4a9ea347ca7b8f032ba307b3ffab917ae" }, "downloads": -1, "filename": "cellex-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "747b4dcaff2589063684e53e247cacff", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 41266, "upload_time": "2019-09-24T16:04:25", "url": "https://files.pythonhosted.org/packages/b7/16/af3ed51a3d0be39211e9b72579023aa9f871e5338de073ea7698155904e2/cellex-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cc89f10da51a72e08333369d6c78333a", "sha256": "45eecfe45dcb164208b489bdcb54cffe989cee6f6b2805934a333640fd017f0e" }, "downloads": -1, "filename": "cellex-1.0.0.tar.gz", "has_sig": false, "md5_digest": "cc89f10da51a72e08333369d6c78333a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6220283, "upload_time": "2019-09-24T16:04:29", "url": "https://files.pythonhosted.org/packages/96/7f/f249cb96898b68c384490125bf900ce4fd14b000c0b5608e70932790ffcf/cellex-1.0.0.tar.gz" } ] }