Difference between revisions of "User Guide/SObA"

From WormBaseWiki
Jump to navigationJump to search
(Created page with "== '''Summary of Ontology-based Annotations (SObA)''' == == Submit == Enter a gene list consisting of any accepted C. elegans gene names separated by spaces, colons or tabs...")
 
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
== '''Summary of Ontology-based Annotations (SObA)''' ==
 
  
== Submit ==
+
__TOC__
  
Enter a gene list consisting of any accepted C. elegans gene names separated by spaces, colons or tabs into the box. Alternatively, input a plain-text file of gene names separated by spaces, colons or tabs using the 'Choose file' button. Text files must be plain text (.txt).
+
== What is a SObA graph? ==
The program returns enriched terms as assessed by a hypergeometric function, after FDR correction. A bar chart containing the top 15 (or less) enriched terms, sorted by increasing q-value and by decreasing fold-change is automatically generated. Bar coloring is intended to improve readability, and color does not convey information.
 
<p>Optionally, provide a background gene set as a csv (or simple text) file with a single column without a column name. Gene names must be in wbid format.
 
  
*<b>Sometimes the program's running time is longer than the set 'timeout' interval and it would cause a "504 Gateway Timeout" error. If that happens, please refresh the web page.</b>
+
'''Summary of Ontology-based Annotations (SObA)'''
  
== Result ==
+
SObA provides an abridged, summary view of a full ontology graph, trimmed based on annotations and hierarchical relationships.
The Result table shows all significantly enriched terms, those that have a Q value < 0.1, sorted by their P values.
 
  
The bar chart displays up to 15 significantly enriched terms. Colors are meant to improve readability and do not convey information.
+
For inference reasoning, we follow that defined by [http://geneontology.org/docs/ontology-relations/ GO Relations] where "is a", "part of", and "regulates" are included in inference.
  
== Citation ==
+
Starting with the full ontology graph, we edit the graph by:
 +
* (A) removing all nodes (and their edges) that do not carry any (direct or inferred) annotations;
 +
* (B) removing all nodes that do not have direct (as opposed to inferred) annotations unless they are the lowest common ancestral nodes of two or more descending nodes (lowest common ancestor, LCA);
 +
* (C) applying transitive reduction by removing all paths between a pair of nodes unless they are the longest paths;
 +
* (D) reducing hierarchy depth to focus on broader aspects of ontology (top slicing as a user option).
 +
* (E) scaling node sizes based on the relative number of annotations that each node carries to indicate possible relative importance.
  
[http://bmcbioinformatics.biomedcentral.com/articles/10.1186/s12859-016-1229-9 David Angeles-Albores, Raymond Y. N. Lee, Juancarlos Chan and Paul W. Sternberg, 2016. "Tissue enrichment analysis for C. elegans genomics", BMC Bioinformatics 17:366]
+
== Using SObA graph ==
  
[https://doi.org/10.17912/W25Q2N Angeles-Albores, D; Lee, RYN; Chan, J; Sternberg, PW (2018): Two new functions in the WormBase Enrichment Suite. Micropublication: biology. Dataset. https://doi.org/10.17912/W25Q2N]
+
1. zoom and move nodes around.
 +
2. Select a node or edge for specific information.
 +
3. "Save Image" turns the graph into a high resolution PNG file.
 +
4. Node size scaling may be removed by ticking "Uniform".
 +
5. Displayed graph depth may be set at will (Graph Depth).
 +
6. Graph display may be faceted by evidence types or ontology aspects (GO only).
 +
 
 +
== Types of SObA graph ==
 +
 
 +
=== Single gene ===
 +
SObA single gene graph presents the ontology annotations of a single gene
 +
 
 +
=== Pair of genes ===
 +
SObA paired genes combines and compares ontology annotations of a pair of genes.
 +
 
 +
Select genes:
 +
 
 +
1. Pick an ontology type.
 +
2. In the text box, enter the name or identifier of the first gene (e.g. lin-3, wbgene00002992, or F36H1.4) and choose from a list of genes returned by auto-complete.
 +
3. Enter and select the second gene.
 +
4. If a gene is not in the list returned, there may be no annotated data.
 +
 
 +
In the returned SObA graph, each node is sized based on the annotation count for that ontology term, by combining the counts of both genes. A colored slice represents % annotation count. There are two types of slices.
 +
 
 +
1. Absolute count slices - A slice is % (Annotation count of a gene for node / Annotation count of both genes for node).
 +
2. Relative count slices - A slice is % (Annotation count of a gene for node / Total annotation count for the same gene); a gene slice can take up no more than half of the node area. Thus if there is a single root node (all ontologies but GO), half of it is filled with red and the other half blue, as each gene's annotation count is equal to the total.
 +
 
 +
=== List of terms ===
 +
With the results of an enrichment analysis, one can draw a SObA graph. Enter a list of ontology terms and their corresponding statistical (correct-P or Q) value into the text box. The input may be in the two-column table format. The first column must be terms of the same ontology. The second column is optional.

Latest revision as of 21:32, 30 October 2019

What is a SObA graph?

Summary of Ontology-based Annotations (SObA)

SObA provides an abridged, summary view of a full ontology graph, trimmed based on annotations and hierarchical relationships.

For inference reasoning, we follow that defined by GO Relations where "is a", "part of", and "regulates" are included in inference.

Starting with the full ontology graph, we edit the graph by:

  • (A) removing all nodes (and their edges) that do not carry any (direct or inferred) annotations;
  • (B) removing all nodes that do not have direct (as opposed to inferred) annotations unless they are the lowest common ancestral nodes of two or more descending nodes (lowest common ancestor, LCA);
  • (C) applying transitive reduction by removing all paths between a pair of nodes unless they are the longest paths;
  • (D) reducing hierarchy depth to focus on broader aspects of ontology (top slicing as a user option).
  • (E) scaling node sizes based on the relative number of annotations that each node carries to indicate possible relative importance.

Using SObA graph

1. zoom and move nodes around.
2. Select a node or edge for specific information.
3. "Save Image" turns the graph into a high resolution PNG file.
4. Node size scaling may be removed by ticking "Uniform".
5. Displayed graph depth may be set at will (Graph Depth).
6. Graph display may be faceted by evidence types or ontology aspects (GO only).

Types of SObA graph

Single gene

SObA single gene graph presents the ontology annotations of a single gene

Pair of genes

SObA paired genes combines and compares ontology annotations of a pair of genes.

Select genes:

1. Pick an ontology type.
2. In the text box, enter the name or identifier of the first gene (e.g. lin-3, wbgene00002992, or F36H1.4) and choose from a list of genes returned by auto-complete.
3. Enter and select the second gene.
4. If a gene is not in the list returned, there may be no annotated data.

In the returned SObA graph, each node is sized based on the annotation count for that ontology term, by combining the counts of both genes. A colored slice represents % annotation count. There are two types of slices.

1. Absolute count slices - A slice is % (Annotation count of a gene for node / Annotation count of both genes for node).
2. Relative count slices - A slice is % (Annotation count of a gene for node / Total annotation count for the same gene); a gene slice can take up no more than half of the node area. Thus if there is a single root node (all ontologies but GO), half of it is filled with red and the other half blue, as each gene's annotation count is equal to the total.

List of terms

With the results of an enrichment analysis, one can draw a SObA graph. Enter a list of ontology terms and their corresponding statistical (correct-P or Q) value into the text box. The input may be in the two-column table format. The first column must be terms of the same ontology. The second column is optional.