scDenorm


NamescDenorm JSON
Version 0.0.10 PyPI version JSON
download
home_pagehttps://github.com/changebio/scDenorm
SummaryscDenorm: a denormalization tool for single-cell transcriptomics data
upload_time2024-01-28 04:25:39
maintainer
docs_urlNone
authorYin Huang
requires_python>=3.7
licenseApache Software License 2.0
keywords nbdev jupyter notebook python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            scDenorm
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Install

``` sh
pip install scDenorm

#or

conda install -c changebio scdenorm
```

## How to use

### Using pbmc3k as an example dataset

``` python
import scanpy as sc
from scipy.io import mmwrite
from scDenorm.denorm import *
```

``` python
ad=sc.datasets.pbmc3k()
```

``` python
ad.layers['count']=ad.X.copy()
```

``` python
ad
```

    AnnData object with n_obs × n_vars = 2700 × 32738
        var: 'gene_ids'
        layers: 'count'

``` python
sc.pp.normalize_total(ad, target_sum=1e4)
sc.pp.log1p(ad)
smtx = ad.X.tocsr().asfptype()
```

``` python
smtx.data
```

    array([1.6352079, 1.6352079, 2.2258174, ..., 1.7980369, 1.7980369,
           2.779648 ], dtype=float32)

``` python
ad.write_h5ad('data/pbmc3k_norm.h5ad')
```

write out as sparse matrix

``` python
mmwrite('data/scaled.mtx', smtx[1:10,])
```

### In jupyter

#### Input Anndata

``` python
scdenorm('data/pbmc3k_norm.h5ad',fout='data/pbmc3k_denorm.h5ad',verbose=1)
```

    INFO:root:Reading input file: data/pbmc3k_norm.h5ad
    INFO:root:The dimensions of this data are (2700, 32738).
    INFO:root:select base
    INFO:root:denormlizing ...
    100%|██████████| 2700/2700 [00:00<00:00, 2900.90it/s]
    INFO:root:Writing output file: data/pbmc3k_denorm.h5ad

return a new anndata if there is no output path.

``` python
new_ad=scdenorm('data/pbmc3k_norm.h5ad')
```

    100%|██████████| 2700/2700 [00:00<00:00, 2969.22it/s]

``` python
new_ad
```

    View of AnnData object with n_obs × n_vars = 2700 × 32738
        var: 'gene_ids'
        uns: 'log1p'

``` python
ad.layers['count'].data
```

    array([1., 1., 2., ..., 1., 1., 3.], dtype=float32)

``` python
new_ad.X.data
```

    array([1.       , 1.       , 2.0000002, ..., 1.       , 1.       ,
           3.       ], dtype=float32)

#### Input sparse matrix with cell by gene

If it is gene by cell, set `gxc=True`.

``` python
scdenorm('data/scaled.mtx',fout='data/scd_scaled.h5ad')
```

    100%|██████████| 9/9 [00:00<00:00, 2883.12it/s]

### In command line

#### Input Anndata

``` python
!scdenorm data/pbmc3k_norm.h5ad --fout data/pbmc3k_denorm.h5ad
```

    100%|█████████████████████████████████████| 2700/2700 [00:00<00:00, 2719.59it/s]

#### Input sparse matrix with cell by gene

``` python
!scdenorm data/scaled.mtx --fout data/scd_scaled_c.h5ad
```

    100%|███████████████████████████████████████████| 9/9 [00:00<00:00, 1333.31it/s]

or output `mtx` format.

``` python
!scdenorm data/scaled.mtx --fout data/scd_scaled_c.mtx
```

    100%|███████████████████████████████████████████| 9/9 [00:00<00:00, 1290.78it/s]



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/changebio/scDenorm",
    "name": "scDenorm",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "nbdev jupyter notebook python",
    "author": "Yin Huang",
    "author_email": "changebio@yeah.net",
    "download_url": "https://files.pythonhosted.org/packages/51/cf/5f37a372b92cad7b58f5e9502ccbc1a54f72238d041a18c80762f2b07f8a/scDenorm-0.0.10.tar.gz",
    "platform": null,
    "description": "scDenorm\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Install\n\n``` sh\npip install scDenorm\n\n#or\n\nconda install -c changebio scdenorm\n```\n\n## How to use\n\n### Using pbmc3k as an example dataset\n\n``` python\nimport scanpy as sc\nfrom scipy.io import mmwrite\nfrom scDenorm.denorm import *\n```\n\n``` python\nad=sc.datasets.pbmc3k()\n```\n\n``` python\nad.layers['count']=ad.X.copy()\n```\n\n``` python\nad\n```\n\n    AnnData object with n_obs \u00d7 n_vars = 2700 \u00d7 32738\n        var: 'gene_ids'\n        layers: 'count'\n\n``` python\nsc.pp.normalize_total(ad, target_sum=1e4)\nsc.pp.log1p(ad)\nsmtx = ad.X.tocsr().asfptype()\n```\n\n``` python\nsmtx.data\n```\n\n    array([1.6352079, 1.6352079, 2.2258174, ..., 1.7980369, 1.7980369,\n           2.779648 ], dtype=float32)\n\n``` python\nad.write_h5ad('data/pbmc3k_norm.h5ad')\n```\n\nwrite out as sparse matrix\n\n``` python\nmmwrite('data/scaled.mtx', smtx[1:10,])\n```\n\n### In jupyter\n\n#### Input Anndata\n\n``` python\nscdenorm('data/pbmc3k_norm.h5ad',fout='data/pbmc3k_denorm.h5ad',verbose=1)\n```\n\n    INFO:root:Reading input file: data/pbmc3k_norm.h5ad\n    INFO:root:The dimensions of this data are (2700, 32738).\n    INFO:root:select base\n    INFO:root:denormlizing ...\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 2700/2700 [00:00<00:00, 2900.90it/s]\n    INFO:root:Writing output file: data/pbmc3k_denorm.h5ad\n\nreturn a new anndata if there is no output path.\n\n``` python\nnew_ad=scdenorm('data/pbmc3k_norm.h5ad')\n```\n\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 2700/2700 [00:00<00:00, 2969.22it/s]\n\n``` python\nnew_ad\n```\n\n    View of AnnData object with n_obs \u00d7 n_vars = 2700 \u00d7 32738\n        var: 'gene_ids'\n        uns: 'log1p'\n\n``` python\nad.layers['count'].data\n```\n\n    array([1., 1., 2., ..., 1., 1., 3.], dtype=float32)\n\n``` python\nnew_ad.X.data\n```\n\n    array([1.       , 1.       , 2.0000002, ..., 1.       , 1.       ,\n           3.       ], dtype=float32)\n\n#### Input sparse matrix with cell by gene\n\nIf it is gene by cell, set `gxc=True`.\n\n``` python\nscdenorm('data/scaled.mtx',fout='data/scd_scaled.h5ad')\n```\n\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 9/9 [00:00<00:00, 2883.12it/s]\n\n### In command line\n\n#### Input Anndata\n\n``` python\n!scdenorm data/pbmc3k_norm.h5ad --fout data/pbmc3k_denorm.h5ad\n```\n\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 2700/2700 [00:00<00:00, 2719.59it/s]\n\n#### Input sparse matrix with cell by gene\n\n``` python\n!scdenorm data/scaled.mtx --fout data/scd_scaled_c.h5ad\n```\n\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 9/9 [00:00<00:00, 1333.31it/s]\n\nor output `mtx` format.\n\n``` python\n!scdenorm data/scaled.mtx --fout data/scd_scaled_c.mtx\n```\n\n    100%|\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588| 9/9 [00:00<00:00, 1290.78it/s]\n\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "scDenorm: a denormalization tool for single-cell transcriptomics data",
    "version": "0.0.10",
    "project_urls": {
        "Homepage": "https://github.com/changebio/scDenorm"
    },
    "split_keywords": [
        "nbdev",
        "jupyter",
        "notebook",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e188d920c8a28384bd20d00fcb391e913bfdf5aca5b6109b9b4e21d4ef13b1da",
                "md5": "ad70b8a8b1b34b1222fd400d9a880cf0",
                "sha256": "e442763e1b6e21320d0aa5b3eddf6e9021de9dd0a12757e68c2bd744ad82beeb"
            },
            "downloads": -1,
            "filename": "scDenorm-0.0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad70b8a8b1b34b1222fd400d9a880cf0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 11345,
            "upload_time": "2024-01-28T04:25:37",
            "upload_time_iso_8601": "2024-01-28T04:25:37.803021Z",
            "url": "https://files.pythonhosted.org/packages/e1/88/d920c8a28384bd20d00fcb391e913bfdf5aca5b6109b9b4e21d4ef13b1da/scDenorm-0.0.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "51cf5f37a372b92cad7b58f5e9502ccbc1a54f72238d041a18c80762f2b07f8a",
                "md5": "6d62dea310d4debfe250e8a441f9ed1a",
                "sha256": "afb6bdde16fe731a403052bce4b9f6e79487570f4e00a8af4ea68915f19b4b93"
            },
            "downloads": -1,
            "filename": "scDenorm-0.0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "6d62dea310d4debfe250e8a441f9ed1a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11622,
            "upload_time": "2024-01-28T04:25:39",
            "upload_time_iso_8601": "2024-01-28T04:25:39.880919Z",
            "url": "https://files.pythonhosted.org/packages/51/cf/5f37a372b92cad7b58f5e9502ccbc1a54f72238d041a18c80762f2b07f8a/scDenorm-0.0.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-28 04:25:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "changebio",
    "github_project": "scDenorm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "scdenorm"
}
        
Elapsed time: 0.16720s