BTM


NameBTM JSON
Version 1.1.3 PyPI version JSON
download
home_pagehttps://github.com/shuzhao-li/BTM
SummaryBlood Transcription Modules for transcriptomics analysis
upload_time2023-07-14 13:43:44
maintainer
docs_urlNone
authorShuzhao Li
requires_python
licenseMIT
keywords transcriptomics analysis bioinformatics immunology systems biology
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # BTM (Blood Transcription Modules)

Gene modules to interpret blood transcriptomics data.

Used as alternative to conventional pathways, offering granular immunology and often better sensitivity.
The modules can also be used as gene sets for GSEA analysis.
This is the BTM modules described in

- Li, S., Rouphael, N., Duraisingham, S., Romero-Steiner, S., Presnell, S., Davis, C., ..., Pulendran, B. (2014). Molecular signatures of antibody responses derived from a systems biological study of 5 human vaccines. Nature immunology, 15(2), 195.  https://www.nature.com/articles/ni.2789


## Installation
```
pip install BTM
```

## BTM_Plus at 2021

An update with the help of Amnah Siddiqa.

This set of modules excludes all TBA modules, and replaces the cell specific markers by a new set of markers
compiled from these three papers:

- Aran, D., Hu, Z. and Butte, A.J., 2017. xCell: digitally portraying the tissue cellular heterogeneity landscape. Genome biology, 18(1), pp.1-14.
- Zhang, X., Lan, Y., Xu, J., Quan, F., Zhao, E., Deng, C., Luo, T., Xu, L., Liao, G., Yan, M. and Ping, Y., 2019. CellMarker: a manually curated resource of cell markers in human and mouse. Nucleic acids research, 47(D1), pp.D721-D728.
- Monaco, G., Lee, B., Xu, W., Mustafah, S., Hwang, Y.Y., Carre, C., Burdin, N., Visan, L., Ceccarelli, M., Poidinger, M. and Zippelius, A., 2019. RNA-Seq signatures normalized by mRNA abundance allow absolute deconvolution of human immune cell types. Cell reports, 26(6), pp.1627-1640.

The cell specific markers were merged by keeping genes in at least half of the source sets. 
I.e., if 5 genesets exist for the same cell population, a gene is kept if it appears in at least 3 of the genesets.
All genesets/modules larger than 100 genes are excluded from BTM_Plus.

```
>>> from BTM_Plus import BTM_Plus as B2
>>> len(B2)
276
>>> B2[88]
{'id': 'P089', 
'name': 'mismatch repair (I)', 
'src': ['Li-Pulendran, Li_M22.0_mismatch repair (I)'], 
'genes': ['SMC1A', 'POLA1', 'NCAPG2', 'RFC5', 'RFC4', 'MSH2', 'TMPO', 'MSH6', 'RFC2', 'GMNN', 'BUB1', 'RMI1', 'RACGAP1', 'EXO1', 'POLD3', 'PRIM1', 'ZWINT', 'CHEK1', 'CENPK', 'FIGNL1', 'MCM6', 'RFC3', 'SSBP1', 'TOPBP1', 'RPA3', 'SMC2']}
```

## To generate permutations of BTM_Plus 

In same directory, change Number_Permutation to your need -
```
python permutate.py
```

This writes two files,
'resampled_BTM_Plus.txt', 
'random_genesets.txt',
each line of a geneset of size 50 (default).

## Example use of the 2013 version (Companion to original paper)

To convert gene level data to BTM module activity scores:
```
from btm.btm_tool import genetable_to_activityscores
genetable_to_activityscores(infile, outfile)
```

Download tutorial package at
https://media.nature.com/original/nature-assets/ni/journal/v15/n2/extref/ni.2789-S5.zip

This "BTM_tutorial_package" download package should contain -
btm_tool.py, btm_example_data.py, MCV4_D3v0_probesets.txt,
gene_ab_correlation.rnk, BTM_for_GSEA_20131008.gmt, monocytes_vs_bcells.txt.

The btm_tool.py is to illustrate

1. Converting gene level data to BTM activity table. (Can also convert Affy probeset level data to gene level data.)
2. Enrichment test of an input gene list.
3. Testing antibody correlation to gene expression at module level.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/shuzhao-li/BTM",
    "name": "BTM",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "transcriptomics analysis bioinformatics immunology systems biology",
    "author": "Shuzhao Li",
    "author_email": "shuzhao.li@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3b/6b/23287b9da87f3f20d2c0a932d224a7667ccb0592d5aa04603eb14e069ca7/BTM-1.1.3.tar.gz",
    "platform": null,
    "description": "# BTM (Blood Transcription Modules)\n\nGene modules to interpret blood transcriptomics data.\n\nUsed as alternative to conventional pathways, offering granular immunology and often better sensitivity.\nThe modules can also be used as gene sets for GSEA analysis.\nThis is the BTM modules described in\n\n- Li, S., Rouphael, N., Duraisingham, S., Romero-Steiner, S., Presnell, S., Davis, C., ..., Pulendran, B. (2014). Molecular signatures of antibody responses derived from a systems biological study of 5 human vaccines. Nature immunology, 15(2), 195.  https://www.nature.com/articles/ni.2789\n\n\n## Installation\n```\npip install BTM\n```\n\n## BTM_Plus at 2021\n\nAn update with the help of Amnah Siddiqa.\n\nThis set of modules excludes all TBA modules, and replaces the cell specific markers by a new set of markers\ncompiled from these three papers:\n\n- Aran, D., Hu, Z. and Butte, A.J., 2017. xCell: digitally portraying the tissue cellular heterogeneity landscape. Genome biology, 18(1), pp.1-14.\n- Zhang, X., Lan, Y., Xu, J., Quan, F., Zhao, E., Deng, C., Luo, T., Xu, L., Liao, G., Yan, M. and Ping, Y., 2019. CellMarker: a manually curated resource of cell markers in human and mouse. Nucleic acids research, 47(D1), pp.D721-D728.\n- Monaco, G., Lee, B., Xu, W., Mustafah, S., Hwang, Y.Y., Carre, C., Burdin, N., Visan, L., Ceccarelli, M., Poidinger, M. and Zippelius, A., 2019. RNA-Seq signatures normalized by mRNA abundance allow absolute deconvolution of human immune cell types. Cell reports, 26(6), pp.1627-1640.\n\nThe cell specific markers were merged by keeping genes in at least half of the source sets. \nI.e., if 5 genesets exist for the same cell population, a gene is kept if it appears in at least 3 of the genesets.\nAll genesets/modules larger than 100 genes are excluded from BTM_Plus.\n\n```\n>>> from BTM_Plus import BTM_Plus as B2\n>>> len(B2)\n276\n>>> B2[88]\n{'id': 'P089', \n'name': 'mismatch repair (I)', \n'src': ['Li-Pulendran, Li_M22.0_mismatch repair (I)'], \n'genes': ['SMC1A', 'POLA1', 'NCAPG2', 'RFC5', 'RFC4', 'MSH2', 'TMPO', 'MSH6', 'RFC2', 'GMNN', 'BUB1', 'RMI1', 'RACGAP1', 'EXO1', 'POLD3', 'PRIM1', 'ZWINT', 'CHEK1', 'CENPK', 'FIGNL1', 'MCM6', 'RFC3', 'SSBP1', 'TOPBP1', 'RPA3', 'SMC2']}\n```\n\n## To generate permutations of BTM_Plus \n\nIn same directory, change Number_Permutation to your need -\n```\npython permutate.py\n```\n\nThis writes two files,\n'resampled_BTM_Plus.txt', \n'random_genesets.txt',\neach line of a geneset of size 50 (default).\n\n## Example use of the 2013 version (Companion to original paper)\n\nTo convert gene level data to BTM module activity scores:\n```\nfrom btm.btm_tool import genetable_to_activityscores\ngenetable_to_activityscores(infile, outfile)\n```\n\nDownload tutorial package at\nhttps://media.nature.com/original/nature-assets/ni/journal/v15/n2/extref/ni.2789-S5.zip\n\nThis \"BTM_tutorial_package\" download package should contain -\nbtm_tool.py, btm_example_data.py, MCV4_D3v0_probesets.txt,\ngene_ab_correlation.rnk, BTM_for_GSEA_20131008.gmt, monocytes_vs_bcells.txt.\n\nThe btm_tool.py is to illustrate\n\n1. Converting gene level data to BTM activity table. (Can also convert Affy probeset level data to gene level data.)\n2. Enrichment test of an input gene list.\n3. Testing antibody correlation to gene expression at module level.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Blood Transcription Modules for transcriptomics analysis",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://github.com/shuzhao-li/BTM"
    },
    "split_keywords": [
        "transcriptomics",
        "analysis",
        "bioinformatics",
        "immunology",
        "systems",
        "biology"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e797ba5f74adeee0c27e60451c9301e73b61c2ca0038a02551a71e5be10c84f",
                "md5": "cc53d76b3b0a66fd2da5f8786009b245",
                "sha256": "7f66ef484bf53d345a57e11a0a86c327fae787fbbdf6a440c15ec7288cca3295"
            },
            "downloads": -1,
            "filename": "BTM-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cc53d76b3b0a66fd2da5f8786009b245",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 1579428,
            "upload_time": "2023-07-14T13:43:42",
            "upload_time_iso_8601": "2023-07-14T13:43:42.011800Z",
            "url": "https://files.pythonhosted.org/packages/9e/79/7ba5f74adeee0c27e60451c9301e73b61c2ca0038a02551a71e5be10c84f/BTM-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b6b23287b9da87f3f20d2c0a932d224a7667ccb0592d5aa04603eb14e069ca7",
                "md5": "2cb217c544f9e06704d0b0c1281b6de1",
                "sha256": "00062d14945c76a206be730e2c10a887dd448007072283c1402b143250928075"
            },
            "downloads": -1,
            "filename": "BTM-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2cb217c544f9e06704d0b0c1281b6de1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1525141,
            "upload_time": "2023-07-14T13:43:44",
            "upload_time_iso_8601": "2023-07-14T13:43:44.144665Z",
            "url": "https://files.pythonhosted.org/packages/3b/6b/23287b9da87f3f20d2c0a932d224a7667ccb0592d5aa04603eb14e069ca7/BTM-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-14 13:43:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "shuzhao-li",
    "github_project": "BTM",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "btm"
}
        
Elapsed time: 0.12097s