AmiGO 2 Manual: Search: Difference between revisions

From GO Wiki
Jump to navigation Jump to search
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page gives some examples of advanced search usage in the [http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search AmiGO 2 beta]
= Introduction =


== Annotations ==
AmiGO 2 now provides a powerful method of rapidly searching using pre-computed indexes. In addition to speed, Search provides boolean operators, wildcards, and fuzzy searches.


For annotation queries, start at
= Basic Usage =
http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search


The default tab is "annotation"
The largest initial difference, when compared to the traditional AmiGO search, is that results are returned incrementally as you type or manipulate the filters. It should be noted that the search only increments when typing when there are over three characters entered and when you are typing forward with standard characters (spaces, backspaces, and the like will not increment the search).


Note that in this tab, you are querying on a per-annotation basis
If you wish to search for an exact simple keyword, like ''nucleus'', you should either '''add a space after the word''' or use quotes around the word '''"nucleus"'''.


=== Neurogenesis ===
== Text filtering ==


Motivation: find Wnt family proteins involved in neurogenesis
For our first example, let's say that you want to search for ''pleckstrin''. As you type it in, you will get results incrementally returned for ''ple'', ''plec'', and finally ''pleckstrin''. If you continued and entered:


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
pleckstrin domain
# Type '''neurogenesis''' into the filter box
# Use arrows to browse through results
# Filter by source - open "source" filter on left and select MGI
# Click on [http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/term/GO:0022008 neurogenesis] in one of the rows, taking you to the neurogenesis page
# Note that there are more results here - results include all descendants (isa, partof, regulates) of neurogenesis
# Open 'family' and select 'wnt related'


You would get a list of annotation that contain in their record ''pleckstrin'', ''domain'', or both (see [[#Boolean Operators (and/or/not)|#Boolean Operators]] below). Finally, if you want to search for the phrase ''pleckstrin domain'', where the words occur side by side, you would have to put the phrase in quotes:


=== Epithelia-related processes outside bilateria ===
"pleckstrin domain"


Motivation: epithelial cells are often regarded to be eumetazoan innovations. Here we use AmiGO 2 to explore this hypothesis and check for potential errorsin GO.
== Boolean Operators (and/or/-) ==


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search - the starting point is all annotations
You may also use boolean logic and nesting in the search. For example, if you wanted to see all records that contain both ''pleckstrin'' and ''domain'' in them, you would enter:
# Type: '''epithel''' in the filter box to the left of the results. The results are very inclusive - anything that matches this string in any field, or descendent of term that matches this string. Approx ~10k annotations
# Open "taxon" facet
# Select "-" next to bilateria


Explore the results using the left and right arrows. At the time of writing there are some obvious erroroneus annotations - can you spot them? You can filter out the IEA using the "evidence" filter.
pleckstrin and domain


=== Cell Cycle Phases (annotation extensions)
To exclude ''domain'' from ''pleckstrin'' results, you would enter:


Motivation: The cell cycle phase terms may soon be separated from the main GO process hierarchy. Rather than annotating to these directly, they will be annotated to indirectly, through either pre-composed TG generated terms that use "during <phase>" as differentia, or as annotation extensions. We can see this now with many PomBase annotations.
pleckstrin and -domain


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
To get everything that has, ''pleckstrin'', ''domain'', or both, you would enter:
# Select "PomBase" in "source" facet
# Open "annotation extension" facet
# Select "cell cycle phase" (should be near top)
# Explore different annotations
# Try a more specific phase in the extension facet - e.g. M phase


=== Neuron-related processes (annotation extensions) ===
pleckstrin or domain


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search - the starting point is all annotations
Note that:
# Open "annotation extension" facet
# Click "more"
# Search (e.g. ctrol+F in browser) for neuron and select "+"
# Explore deeper in neuron hierarchy via "extension" facet


== Gene Products ==
pleckstrin or domain
pleckstrin domain


''in progress''
Are functionally equivalent--spaces between words are considered to be an implicit ''or''. This is the reason that you need to quote phrases when you want them to appear together.


For gene product queries, go to
We can also nest our boolean search with parentheses. If you wanted to search for ''top'' in conjunction with either ''alpha'' or ''beta'', you would enter:
http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
And select "Gene/products" or follow this [http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search?golr_class=bbop_bio link].


top and (alpha or beta)


=== Limb Morphogenesis ===
For more about the results from ''top'' (and why there are not as many as you think), please see the next section.


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search - then select "gene products"
== Wildcards ==
# Type "limb morphogenesis" in the filter field
# Open "involved in" and click "+" on "limb morphogenesis"
# ...


== Ontology ==
The default mode of the Search component is to apply a wildcard ("*") to the end of any search token that does not have a space after it.


For ontology queries, go to
== Filtering  and Facets ==
http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
And select "Ontology" or follow this [http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search?golr_class=bbop_ont link].


Alternatively you can query from the main search bar: http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo
TODO


=== neurogenesis ===
The annotations, terms, and gene product searches have different (and hopefully self-explanatory) filters that you can apply to them to reduce the number of returned results. Let's say that you've search for the phrase:


Motivation: explore neurogenesis
"pleckstrin domain"


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo
And wish to just see the results for RGD. You can do this by clicking the "RGD" item in the "Data source" filter box. Multiple filters can be added by holding a control key (varies by operating system and browser) while clicking on filters. Any combination of filters may be added; to remove a filter set, click on "No filter" item, the first item in each filter set.
# Type "neurogenesis"
# As you are typing, autocomplete should provide suggestions, with the desired term at the top
# Select '''neurogenesis'''
# This should take you here: http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/term/GO:0022008


From here you can:


# Explore annotations - use the facets on the left side to filter your search
= Advanced Usage =
# Explore neighboring terms - use "inferred tree view" for a compacted tree display


=== Non-nuclear chromosomes ===
For full information about the query syntax and special characters, please see the [http://lucene.apache.org/java/1_4_3/queryparsersyntax.html Lucene documentation].


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
== Additional Search Fields ==
# Select "Ontology" tab
# Open "source" facet
# Select 'cell component'
# Open part-of/involved in facet
# Select + chromosome
# In part-of/involved in facet, select "-" next to nucleus (negative filter)
#


TODO


=== All obsolete terms in subsets ===
See the schema details introspection tool.


Motivation: ontology subset maintainers may wish to check if there are stale terms in subsets
== Fuzzy Searches and Levenshtein Distance ==


# Start at http://amigo2.berkeleybop.org/cgi-bin/amigo2/amigo/search
This section is not yet complete. In the meantime, please see the [http://lucene.apache.org/java/2_9_4/queryparsersyntax.html Lucene documentation]. All of the documentation there should be valid for AmiGO.
# Select "Ontology" tab
# Open "subset" facet
# Select a GO slim - e.g. goslim_prok (note: some will be from other ontologies; use the "source" facet to eliminate these)
# Open "obsoletion" facet - you can see the distribution between obsolete / non-obsolete. Select "+" next to "true" (or "-" next to false)


Note you can also explore boolean combinations of slims - e.g. terms in both yeast and prok slim
==Exotic Searches==


In addition to the types of searches listed above, there are also more exotic types of search that involve ranges, proximity, optional wildcards, boosting, result weights, and others. Unfortunately, these are outside the scope of this document, but are part of the standard syntax. For a more in-depth look at these, please see the [http://lucene.apache.org/java/2_9_4/queryparsersyntax.html Lucene documentation].


[[Category:AmiGO]]
= Example Usage =
 
Example search flows using AmiGO 2 can be found [[AmiGO_2_Manual:_Search_Examples | here]].
 
[[Category:Software]]
[[Category:AmiGO_2_Manual]]
[[Category:AmiGO_2]]
[[Category:AmiGO_2]]

Latest revision as of 04:12, 1 October 2015

Introduction

AmiGO 2 now provides a powerful method of rapidly searching using pre-computed indexes. In addition to speed, Search provides boolean operators, wildcards, and fuzzy searches.

Basic Usage

The largest initial difference, when compared to the traditional AmiGO search, is that results are returned incrementally as you type or manipulate the filters. It should be noted that the search only increments when typing when there are over three characters entered and when you are typing forward with standard characters (spaces, backspaces, and the like will not increment the search).

If you wish to search for an exact simple keyword, like nucleus, you should either add a space after the word or use quotes around the word "nucleus".

Text filtering

For our first example, let's say that you want to search for pleckstrin. As you type it in, you will get results incrementally returned for ple, plec, and finally pleckstrin. If you continued and entered:

pleckstrin domain

You would get a list of annotation that contain in their record pleckstrin, domain, or both (see #Boolean Operators below). Finally, if you want to search for the phrase pleckstrin domain, where the words occur side by side, you would have to put the phrase in quotes:

"pleckstrin domain"

Boolean Operators (and/or/-)

You may also use boolean logic and nesting in the search. For example, if you wanted to see all records that contain both pleckstrin and domain in them, you would enter:

pleckstrin and domain

To exclude domain from pleckstrin results, you would enter:

pleckstrin and -domain

To get everything that has, pleckstrin, domain, or both, you would enter:

pleckstrin or domain

Note that:

pleckstrin or domain
pleckstrin domain

Are functionally equivalent--spaces between words are considered to be an implicit or. This is the reason that you need to quote phrases when you want them to appear together.

We can also nest our boolean search with parentheses. If you wanted to search for top in conjunction with either alpha or beta, you would enter:

top and (alpha or beta)

For more about the results from top (and why there are not as many as you think), please see the next section.

Wildcards

The default mode of the Search component is to apply a wildcard ("*") to the end of any search token that does not have a space after it.

Filtering and Facets

TODO

The annotations, terms, and gene product searches have different (and hopefully self-explanatory) filters that you can apply to them to reduce the number of returned results. Let's say that you've search for the phrase:

"pleckstrin domain"

And wish to just see the results for RGD. You can do this by clicking the "RGD" item in the "Data source" filter box. Multiple filters can be added by holding a control key (varies by operating system and browser) while clicking on filters. Any combination of filters may be added; to remove a filter set, click on "No filter" item, the first item in each filter set.


Advanced Usage

For full information about the query syntax and special characters, please see the Lucene documentation.

Additional Search Fields

TODO

See the schema details introspection tool.

Fuzzy Searches and Levenshtein Distance

This section is not yet complete. In the meantime, please see the Lucene documentation. All of the documentation there should be valid for AmiGO.

Exotic Searches

In addition to the types of searches listed above, there are also more exotic types of search that involve ranges, proximity, optional wildcards, boosting, result weights, and others. Unfortunately, these are outside the scope of this document, but are part of the standard syntax. For a more in-depth look at these, please see the Lucene documentation.

Example Usage

Example search flows using AmiGO 2 can be found here.