Author: | Haibao Tang (tanghaibao), Brent Pedersen (brentp), Fidel Ramirez (fidelram), Aurelien Naldi (aurelien-naldi), Patrick Flick (r4d2), Jeff Yunes (yunesj), Kenta Sato (bicycle1885), Chris Mungall (cmungall), Greg Stupp (stuppie), DV Klopfenstein(dvklopfenstein) |
---|---|
Email: | [email protected] |
License: | BSD |
Contents
- Description
- Installation
- Dependencies
- Cookbook
- iPython Notebooks
- Run a Gene Ontology Enrichment Analysis (GOEA)
- Show many study genes are associated with RNA, translation, mitochondria, and ribosomal
- Report level and depth counts of a set of GO terms
- Find all human protein-coding genes associated with cell cycle
- Calculate annotation coverage of GO terms on various species
- Determine the semantic similarities between GO terms
- Reference
This package contains a Python library to
- process over- and under-representation of certain GO terms, based on Fisher's exact test. With numerous multiple correction routines including locally implemented routines for Bonferroni, Sidak, Holm, and false discovery rate. Also included are multiple test corrections from statsmodels: FDR Benjamini/Hochberg, FDR Benjamini/Yekutieli, Holm-Sidak, Simes-Hochberg, Hommel, FDR 2-stage Benjamini-Hochberg, FDR 2-stage Benjamini-Krieger-Yekutieli, FDR adaptive Gavrilov-Benjamini-Sarkar, Bonferroni, Sidak, and Holm.
- process the obo-formatted file from Gene Ontology website. The data structure is a directed acyclic graph (DAG) that allows easy traversal from leaf to root.
- map GO terms (or protein products with multiple associations to GO terms) to GOslim terms (analog to the map2slim.pl script supplied by geneontology.org)
Make sure your Python version >= 2.7, install the latest stable version via PyPI:
easy_install goatools
To install the development version:
pip install git+git://github.com/tanghaibao/goatools.git
.obo
file for the most current GO:
wget http://geneontology.org/ontology/go-basic.obo
.obo
file for the most current GO Slim
terms (e.g. generic GOslim)
wget http://www.geneontology.org/ontology/subsets/goslim_generic.obo
fisher (required) for calculating Fisher's exact test:
easy_install fisher
statsmodels (optional) for access to a variety of statistical tests for GOEA:
easy_install statsmodels
To plot the ontology lineage, install one of these two options:
Graphviz
Graphviz, for graph visualization.
pygraphviz, Python binding for communicating with Graphviz:
easy_install pygraphviz
pydot, a Python interface to Graphviz's Dot language.
- pyparsing is a prerequisite for pydot
- Images can be viewed using either:
- ImageMagick's display
- Graphviz
run.sh
contains example cases, which calls the utility scripts in the
scripts
folder.
See find_enrichment.py
for usage. It takes as arguments files containing:
- gene names in a study
- gene names in population (or other study if --compare is specified)
- an association file that maps a gene name to a GO category.
Please look at tests/data/
folder to see examples on how to make these
files. when ready, the command looks like:
python scripts/find_enrichment.py --pval=0.05 --indent data/study data/population data/association
and can filter on the significance of (e)nrichment or (p)urification. it can report various multiple testing corrected p-values as well as the false discovery rate.
The "e" in the "Enrichment" column means "enriched" - the concentration of GO term in the study group is significantly higher than those in the population. The "p" stands for "purified" - significantly lower concentration of the GO term in the study group than in the population.
Important note: by default, find_enrichment.py
propagates counts to all
the parents of a GO term. As a result, users may find terms in the output that
are not present in their association
file. Use --no_propagate_counts
to
disable this behavior.
See plot_go_term.py
for usage. plot_go_term.py
can plot the lineage of
a certain GO term, by:
python scripts/plot_go_term.py --term=GO:0008135
This command will plot the following image.
Sometimes people like to stylize the graph themselves, use option --gml
to
generate a GML output which can then be used in an external graph editing
software like Cytoscape. The following image is
produced by importing the GML file into Cytoscape using yFile orthogonal
layout and solid VizMapping. Note that the GML reader plugin may need to be
downloaded and installed in the plugins
folder of Cytoscape:
python scripts/plot_go_term.py --term=GO:0008135 --gml
See map_to_slim.py
for usage. As arguments it takes the gene ontology files:
- the current gene ontology file
go-basic.obo
- the GOslim file to be used (e.g.
goslim_generic.obo
or any other GOslim file)
The script either maps one GO term to it's GOslim terms, or protein products with multiple associations to all it's GOslim terms.
To determine the GOslim terms for a single GO term, you can use the following command:
python scripts/map_to_slim.py --term=GO:0008135 go-basic.obo goslim_generic.obo
To determine the GOslim terms for protein products with multiple associations:
python scripts/map_to_slim.py --association_file=data/association go-basic.obo goslim_generic.obo
Where the association
file has the same format as used for
find_enrichment.py
.
The implemented algorithm is described in more detail at the go-perl documenation of map2slim.
We have implemented several significance tests:
bonferroni
, bonferroni correctionsidak
, sidak correctionholm
, hold correctionfdr
, false discvery rate (fdr) implementation using resampling
Additional methods are available if statsmodels
is installed:
sm_bonferroni
, bonferroni one-step correctionsm_sidak
, sidak one-step correctionsm_holm-sidak
, holm-sidak step-down method using Sidak adjustmentssm_holm
, holm step-down method using Bonferroni adjustmentssimes-hochberg
, simes-hochberg step-up method (independent)hommel
, hommel closed method based on Simes tests (non-negative)fdr_bh
, fdr correction with Benjamini/Hochberg (non-negative)fdr_by
, fdr correction with Benjamini/Yekutieli (negative)fdr_tsbh
, two stage fdr correction (non-negative)fdr_tsbky
, two stage fdr correction (non-negative)
In total 14 tests are availble, which can be selected using option --method
.
Please note that the default FDR (fdr
) uses a resampling strategy which may
lead to slightly different q-values between runs.
https://github.com/tanghaibao/goatools/blob/master/notebooks/goea_nbt3102.ipynb
https://github.com/tanghaibao/goatools/blob/master/notebooks/goea_nbt3102_group_results.ipynb
https://github.com/tanghaibao/goatools/blob/master/notebooks/report_depth_level.ipynb
https://github.com/tanghaibao/goatools/blob/master/notebooks/cell_cycle.ipynb
https://github.com/tanghaibao/goatools/blob/master/notebooks/annotation_coverage.ipynb
https://github.com/tanghaibao/goatools/blob/master/notebooks/semantic_similarity.ipynb
Haibao Tang et al. (2015). GOATOOLS: Tools for Gene Ontology. Zenodo. 10.5281/zenodo.31628.