CLI tool for performing gene set enrichment analysis using the GO database.
Project description
GOpiscator is a command-line tool for performing gene set enrichment analysis using the Gene Ontology (GO) database.
Installation
pip install gopiscator
Usage
Usage: gopiscator [OPTIONS]
GOpiscator (Tool for performing gene set enrichment analysis)
Options:
-i, --gene-list FILE Genes of interest list. [required]
-a, --go-annotation FILE GO annotation file. [required]
-o, --output FILE Write output to a file. [default: (standard output)]
-g, --ontology FILE GO '.obo' file. [default: ('go-basic.obo'; will be downloaded if absent)]
-b, --background-list FILE Background gene list file. [default: (All genes from 'go-annotation' file)]
--threshold FLOAT P-value threshold. [default: 0.05]
--gene-count INTEGER Minimum No. of genes annotated to the specific GO term. [default: 2]
-v, --version Show the version and exit.
-h, --help Show this message and exit.
[!NOTE]
gene-listshould have your genes of interest, one gene per line:
Rv3861 Rv3862c Rv0083 Rv3371
go-annotationshould be tab-delimited with genes in the first column and GO terms in the second column (separated by comma):
Rv0001 GO:0006172,GO:0006275,GO:0006270 Rv0002 GO:0046677,GO:0006260 Rv0003 GO:0009432,GO:0000731,GO:0006260 Rv0005 GO:0046677,GO:0006265,GO:0006261
background-listif you want to use background list of genes, it should have one gene per line:
Rv0001 Rv0002 Rv0003 Rv0005
[!TIP]
If you do not provide
-o, --outputthen the results will be shown in terminal like this:╒════╤════════════╤════════════════════╤═══════════════════════════════╤═══════════╤════════════════════╤═══════════════╕ │ │ GOID │ Ontology │ GO_term_name │ P-value │ Enrichment_score │ Rich_factor │ ╞════╪════════════╪════════════════════╪═══════════════════════════════╪═══════════╪════════════════════╪═══════════════╡ │ 0 │ GO:0045926 │ biological_process │ negative regulation of growth │ 0 │ 4.36 │ 0.2 │ ├────┼────────────┼────────────────────┼───────────────────────────────┼───────────┼────────────────────┼───────────────┤ │ 1 │ GO:0098754 │ biological_process │ detoxification │ 0.015 │ 1.82 │ 0.2 │ ╘════╧════════════╧════════════════════╧═══════════════════════════════╧═══════════╧════════════════════╧═══════════════╛When the
-o, --outputis provided the the output file will look like this:
GOID Ontology GO_term_name Definition P-value FDR Enrichment_score Fold_enrichment Rich_factor GeneRatio BgRatio Count Genes GO:0045926 biological_process negative regulation of growth Any process that… 4.40E-05 0.00171655 4.35640751 9.81395349 0.1627907 7[35] 43[2110] 7 Rv0299,Rv0609,Rv1114,Rv2010,Rv2866,Rv3384c,Rv3697c GO:0098754 biological_process detoxification Any process that… 0.01503798 0.29324058 1.82281055 15.0714286 0.25 3[35] 12[2110] 3 Rv1560,Rv2550c,Rv2801A
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gopiscator-0.1.5.tar.gz.
File metadata
- Download URL: gopiscator-0.1.5.tar.gz
- Upload date:
- Size: 11.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be3f33b15d9b8a4ef8be5cb8008c02aca57104f802b71f9909a544cbefe18565
|
|
| MD5 |
06f93e52e9a63fc1807ac93afbb1f89c
|
|
| BLAKE2b-256 |
b3ada9e44e9191b90ddc925b8c8294ed7c1dacb78133343d71440fea09eb9077
|
File details
Details for the file gopiscator-0.1.5-py3-none-any.whl.
File metadata
- Download URL: gopiscator-0.1.5-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82e8693c26a4878764e0b883ea8b879cde07b49b087787ddb810636c51feb2d1
|
|
| MD5 |
0efa4b03cbaeb2f0d3ce824dca3fdbfc
|
|
| BLAKE2b-256 |
4b824fe397282a4b1b37045e1a9efcddae78bf03fabd71d495bd819e1f1839c0
|