JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / seqfetch.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>Sequence Fetcher</title>
24 </head>
25 <body>
26   <p>
27     <strong>Sequence Fetcher</strong>
28   </p>
29   <p>
30     Jalview can retrieve sequences from certain databases using either
31     the DBFetch service provided by the EMBL European Bioinformatics
32     Institute, or, since Jalview 2.4, DAS servers capable of the <em>sequence</em>
33     command (configured in <a href="dassettings.html">DAS settings</a>).
34   </p>
35   <p>The Sequence Fetcher can be opened via the &quot;File&quot;
36     menu on the main desktop in order to retrieve sequences as a new
37     alignment, or opened via the &quot;File&quot; menu of an existing
38     alignment to import additional sequences. There may be a short delay
39     when the sequence fetcher is first opened, whilst Jalview compiles
40     the list of available sequence datasources from the currently
41     defined DAS server registry.</p>
42   <p>
43     Every time a new fetcher is opened, you will need to <strong>select
44       the database you want to retrieve sequences</strong> from the database
45     chooser.
46   </p>
47   <img src="selectfetchdb.gif" align="left" width="480" height="204"
48     alt="Database selection dialog for fetching sequences (introduced in Jalview 2.8)">
49   <p>
50     The databases are shown as a tree, and ordered alphabetically;
51     tooltips are shown if you mouse over some sources, explaining what
52     the database will retrieve. You can select one by using the up/down
53     arrow keys and hitting return, or by double clicking with the mouse.
54     <br />
55     <em>If you have DAS sources enabled, then you may have several
56       sources for the same type of sequence identifier, and these will
57       be grouped together in a sub-branch branch labeled with the
58       identifier.</em>
59   </p>
60   <p>Once you have selected a sequence database, its fetcher dialog
61     will open. Jalview provides two types of dialog:</p>
62   <ol>
63     <li><strong>The Free-text Search Interface</strong> <br />Free-text
64       search clients are provided for PDB (Since 2.9), and UniProt
65       (Since 2.10). They provide access to each database's own query
66       system, enabling you to retrieve data by accession, free text
67       description, or any other type of supported field. For full
68       details, see each client's help page:
69       <ul>
70         <li><a href="pdbsequencefetcher.html">PDB Sequence
71             Fetcher</a></li>
72         <li><a href="uniprotsequencefetcher.html">UniProt
73             Sequence Fetcher</a></li>
74       </ul></li>
75     <li><strong>Accession based sequence retrieval</strong> <br />
76
77       <img src="seqfetcher.gif" align="center"
78       alt="The Jalview Sequence Fetcher Dialog Box"><br /> To
79       retrieve sequences, simply <strong>enter one or more
80         accession ids</strong> (as a semi-colon separated list), or press the
81       &quot;Example&quot; button to paste the example accession for the
82       currently selected database into the retrieval box. Finally, press
83       &quot;OK&quot; to initiate the retrieval.</li>
84   </ol>
85   <p>
86     <strong>Only retrieving part of a sequence</strong>
87   </p>
88   <p>
89     When using DAS sources (indicated by a &quot;<em>(DAS)</em>&quot;),
90     you can append a range in addition to a sequence ID. For example, to
91     retrieve 50 residues starting at position 35 in UNIPROT sequence
92     P73137 using the UNIPROT DAS server, you would enter
93     &quot;'P73137:35,84'.<br /> <em>Full support for DAS range
94       queries was introduced in Jalview 2.8</em>
95   </p>
96
97   <p>If you use the WSDBFetch sequence fetcher services (EMBL,
98     UniProt, PFAM, and RFAM) in work for publication, please cite:</p>
99   <p>
100     Pillai S., Silventoinen V., Kallio K., Senger M., Sobhany S., Tate
101     J., Velankar S., Golovin A., Henrick K., Rice P., Stoehr P., Lopez
102     R. <br> SOAP-based services provided by the European
103     Bioinformatics Institute.<br> Nucleic Acids Res. 33(1):W25-W28
104     (2005) <br> <br>
105   </p>
106 </body>
107 </html>