AmiGO Manual: Live Search: Difference between revisions

From GO Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
= Overview =
= Overview =


In addition to the [[AmiGO_Manual:_Search | traditional search]], AmiGO now provides a method of searching rapidly using pre-computed indexes.
In addition to the [[AmiGO_Manual:_Search | traditional search]], AmiGO now provides a powerful method of rapidly searching using pre-computed indexes.


= Usage =
= Basic Usage =


The main feature of interest is that you can do an incremental search as you type. The search only initiates when you have over three characters entered and are typing forward (backspaces and the like will not initiate a search).
The largest initial difference, when comapared to the traditional AmiGO search, is that results are returned incrementally as you type. It should be noted that the search only increments when there are over three characters entered and when you are typing forward (backspaces and the like will not increment the search). All examples in the Basic Usage section will assume that you are doing a gene product search (by clicking on the "Gene Product" tab in the search interface).


As an example, when using the gene product search (after clicking the "Gene Product" tab), typing:
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
  pleckstrin domain


will give you a list of gene products that contain this string (or strings) in one of the various gene product database fields. You may also use boolean logic and nesting in the search. For example:
You would get a list of gene products that contain in their record "pleckstrin", "domain", or both. If you wanted to search for the phrase "pleckstrin domain", where the words occur side by side, you would have to put the phrase in quotes:


  pleckstrin AND domain
  "pleckstrin domain"
 
== Filtering ==
 
TODO
 
== Simple Boolean Operators ==
 
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


gives gene products that contain both. Finally, you may also use one of the various results filters to constrain your search. For example, if you click "RGD" under "Source" and input "pleckst", the items returned will contain "pleckst" and/or be sourced from RGD.
gives gene products that contain both. Finally, you may also use one of the various results filters to constrain your search. For example, if you click "RGD" under "Source" and input "pleckst", the items returned will contain "pleckst" and/or be sourced from RGD.
Line 39: Line 49:
= Experimental =
= Experimental =


On the AmiGO Labs server, there may also be similar implementations for searching dbxrefs and associations.
On the AmiGO Labs server, there may also be similar Live Search implementations for dbxrefs and associations.
 
= Troubleshooting =


=Troubleshooting=
* Live Search may occasionally drop a packet of results as you type (especially for fast typers). If you think you should have gotten results, but the display seems "stuck", try erasing the last letter and retyping it.


* Live Search is a new piece of software and some of the [[AmiGO_Labs]] caveats may apply as bugs are worked out. If you have a problem, please contact the GO Helpdesk.
* Live Search is a new piece of software and some of the [[AmiGO_Labs]] caveats may apply as bugs are worked out. If you have a problem, please contact the GO Helpdesk.

Revision as of 17:45, 10 March 2010

Overview

In addition to the traditional search, AmiGO now provides a powerful method of rapidly searching using pre-computed indexes.

Basic Usage

The largest initial difference, when comapared to the traditional AmiGO search, is that results are returned incrementally as you type. It should be noted that the search only increments when there are over three characters entered and when you are typing forward (backspaces and the like will not increment the search). All examples in the Basic Usage section will assume that you are doing a gene product search (by clicking on the "Gene Product" tab in the search interface).

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 gene products that contain in their record "pleckstrin", "domain", or both. If you wanted 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"

Filtering

TODO

Simple Boolean Operators

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

gives gene products that contain both. Finally, you may also use one of the various results filters to constrain your search. For example, if you click "RGD" under "Source" and input "pleckst", the items returned will contain "pleckst" and/or be sourced from RGD.

For more information about the query syntax, please see the lucene documentation.

Additional Search Fields

In additional to typing search text, there are also special fields that you can add to constrain the search beyond the listed filters. These special fields are different depending on whether you are search for terms or gene products.

Term Search

TODO: complete list for terms

Gene Product Search

TODO: complete list for gene products

For example:

aatf and homolset:yes

gives all gene products that contain the string "aatf" and are also a member of a homolog set.

Experimental

On the AmiGO Labs server, there may also be similar Live Search implementations for dbxrefs and associations.

Troubleshooting

  • Live Search may occasionally drop a packet of results as you type (especially for fast typers). If you think you should have gotten results, but the display seems "stuck", try erasing the last letter and retyping it.
  • Live Search is a new piece of software and some of the AmiGO_Labs caveats may apply as bugs are worked out. If you have a problem, please contact the GO Helpdesk.
  • While we aim to be functional on as wide a variety of platforms and browsers as possible, this software depends on features that may not be found in older systems. A complete compatibility list is currently under construction.