JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / uniprotsequencefetcher.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>The UniProt Free Text Search Interface</title>
24 </head>
25 <body>
26
27   <strong>The UniProt Free Text Search Interface</strong>
28   <br /> Since version 2.10 (October 2016), the Jalview Desktop
29   provides a search interface for interactive discovery and retrieval of
30   sequence data from UniProt. This dialog enables UniProt sequence
31   metadata to be searched with free text and structured queries, which
32   allows sequences to be located via gene name, keywords, or even
33   <em>via</em> manual cross-referencing from UniProt or other
34   bioinformatics websites.
35   <p>
36     To open the UniProt Sequence Fetcher, select UniProt as the database
37     from any <a href="seqfetch.html">Sequence Fetcher</a> dialog (opened
38     <em>via</em> <strong>&quot;File &#8594;Fetch
39       Sequences&quot;</strong>).
40   </p>
41   <p>
42     <img src="uniprotseqfetcher.png" align="left"
43       alt="UniProt sequence fetcher (introduced in Jalview 2.10)" />
44   </p>
45
46   <p>
47     <strong>Searching the UniProt Database</strong>
48   </p>
49   <p>
50     To search UniProt, simply begin typing in the text box. After a
51     short delay (about 1.5 seconds), results will be shown in the table
52     below. You can sort results by clicking on the displayed columns,
53     and select entries with the mouse or keyboard. Once you have
54     selected one or more entries, hit the <strong>OK</strong> button to
55     retrieve the sequences.
56   </p>
57   <ul>
58     <li><strong>Searching a specific UniProt field </strong> To
59       find sequences with particular UniProt metadata, you can select a
60       field to search from the drop-down menu.</li>
61
62
63     <li><strong>Bulk UniProt record retrieval</strong><br> To
64       retrieve several uniprot accessions at once, first select <strong>UniProt
65         ID</strong> from the dropdown menu, then paste in the accession IDs as a
66       semi-colon separated list. (e.g. fila_human; mnt_human;
67       mnt_mouse).<br />Hitting Return or OK will automatically fetch
68       those IDs, like the default Sequence Fetcher interface.</li>
69
70     <li><strong><a name="text-search">Complex queries
71           with the UniProt query Syntax</a></strong> The text box also allows complex
72       queries to be entered. The table below provides a brief overview
73       of the supported syntax (see <a href="uniprotqueryfields.html">query
74         fields for UniProtKB</a>):
75       <table border="1" width="95%">
76         <tr>
77           <td><code>human antigen</code></td>
78           <td rowspan="3">All entries containing both terms.</td>
79         </tr>
80         <tr>
81           <td><code>human AND antigen</code></td>
82         </tr>
83         <tr>
84           <td><code>human &amp;&amp; antigen</code></td>
85         </tr>
86         <tr>
87           <td><code>"human antigen"</code></td>
88           <td>All entries containing both terms in the exact order.</td>
89         </tr>
90         <tr>
91           <td><code>human -antigen</code></td>
92           <td rowspan="3">All entries containing the term <code>human</code>
93             but not <code>antigen</code>.
94           </td>
95         </tr>
96         <tr>
97           <td><code>human NOT antigen</code></td>
98         </tr>
99         <tr>
100           <td><code>human ! antigen</code></td>
101         </tr>
102         <tr>
103           <td><code>human OR mouse</code></td>
104           <td rowspan="2">All entries containing either term.</td>
105         </tr>
106         <tr>
107           <td><code>human || mouse</code></td>
108         </tr>
109         <tr>
110           <td><code>antigen AND (human OR mouse)</code></td>
111           <td>Using parentheses to override boolean precedence
112             rules.</td>
113         </tr>
114         <tr>
115           <td><code>anti*</code></td>
116           <td>All entries containing terms starting with <code>anti</code>.
117             Asterisks can also be used at the beginning and within
118             terms. <strong>Note:</strong> Terms starting with an
119             asterisk or a single letter followed by an asterisk can slow
120             down queries considerably.
121           </td>
122         </tr>
123         <tr>
124           <td><code> author:Tiger*</code></td>
125           <td>Citations that have an author whose name starts with
126             <code>Tiger</code>. To search in a specific field of a
127             dataset, you must prefix your search term with the field
128             name and a colon. To discover what fields can be queried
129             explicitly, observe the query hints that are shown after
130             submitting a query or use the query builder (see below).
131           </td>
132         </tr>
133         <tr>
134           <td><code>length:[100 TO *]</code></td>
135           <td>All entries with a sequence of at least 100 amino
136             acids.</td>
137         </tr>
138         <tr>
139           <td><code>citation:(author:Arai author:Chung)</code></td>
140           <td>All entries with a publication that was coauthored by
141             two specific authors.</td>
142         </tr>
143       </table></li>
144   </ul>
145   <p>
146     <strong>Result pagination</strong>
147   </p>
148   The query results returned from the UniProt server are paginated for
149   performance optimisation. The button labelled
150   <strong>'&nbsp;&lt;&lt;&nbsp;'</strong> and
151   <strong>'&nbsp;&gt;&gt;&nbsp;'</strong> can be used to navigate to the
152   next or previous result page respectively. The page range is shown on
153   the title bar of the Free Text Search interface. Jalview's pagination
154   implementation supports multiple selection of entries across multiple
155   pages.
156
157
158   <p>
159     <strong>Customising The UniProt Sequence Fetcher</strong>
160   </p>
161   <p>To change the displayed meta-data in the search result, click
162     the 'Customise Displayed Options' tab, and select the fields you'd
163     like to be displayed or removed.</p>
164   <p>
165     <em>The UniProt Free Test Search Interface was introduced in
166       Jalview 2.10.0</em>
167   </p>
168 </body>
169 </html>