JAL-1645 update 2.9 docs
[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><strong>Sequence Fetcher</strong></p>
27 <p>Jalview can retrieve sequences from certain databases using either the
28 DBFetch service provided by the EMBL European Bioinformatics Institute, or, since Jalview 2.4, DAS servers capable of the <em>sequence</em> command (configured in <a href="dassettings.html">DAS settings</a>).</p>
29         <img src="seqfetcher.gif" align="center"
30                 alt="The Jalview Sequence Fetcher Dialog Box">
31         <p>The Sequence Fetcher dialog box can be opened via the &quot;File&quot; 
32   menu on the main desktop in order to retrieve sequences as a new
33   alignment, or opened via the &quot;File&quot; menu of an existing alignment
34   to import additional sequences. There may be a short delay when the sequence fetcher is first opened, 
35   whilst Jalview compiles the list of available sequence datasources from the 
36   currently defined DAS server registry.
37 </p>
38         <p>First, <strong>select the database you want to retrieve sequences from</strong>
39                 by clicking the button labeled 'Select database retrieval source'. If
40                 a database source is already selected, then the button's label will
41                 change to show the currently selected database.</p>
42                 <img src="selectfetchdb.gif" align="left" alt="Database selection dialog for fetching sequences (introduced in Jalview 2.8)">
43                 <p>Since Jalview 2.8, the
44                 available databases are shown as a tree in a popup dialog box. The
45                 databases are ordered alphabetically, and if there are many sources
46                 for the same type of sequence identifier, they will be grouped
47                 together in a sub-branch branch labeled with the identifier.</p>
48         <p>Once you have selected the sequence database using the popup dialog box, <strong>enter
49   one or more accession ids</strong> (as a semi-colon separated list), or press the 
50   &quot;Example&quot; button to paste the example accession for the currently selected database into the retrieval box.
51    Finally, press &quot;OK&quot; to initiate the retrieval.</p>
52   <p>
53     <strong>Fetching from The PDB with the EMBL-EBI PDBe Search
54       Interface</strong>
55   </p>
56   <p>
57     Since Jalview 2.9, selecting PDB as the sequence database will open
58     the <a href="pdbsequencefetcher.html">PDB Sequence Fetcher</a> for
59     discovering and retrieving structures.
60   </p>
61   <p>
62     <strong>Only retrieving part of a sequence</strong>
63   </p>
64   <p>
65     DAS sources (indicated by a &quot;<em>(DAS)</em>&quot;) allow a
66     range to be specified in addition to a sequence ID. To retrieve 50
67     residues starting at position 35 in UNIPROT sequence P73137 using
68     the UNIPROT DAS server, you would enter &quot;'P73137:35,84'.<br />
69     <em>Full support for DAS range queries was introduced in
70       Jalview 2.8</em>
71   </p>
72
73   <p>If you use the WSDBFetch sequence fetcher services (EMBL, Uniprot, PFAM, and RFAM)
74    in work for publication, please cite:</p>
75 <p>Pillai S., Silventoinen V., Kallio K., Senger M., Sobhany S., Tate J., Velankar 
76   S., Golovin A., Henrick K., Rice P., Stoehr P., Lopez R. <br>
77   SOAP-based services provided by the European Bioinformatics Institute.<br>
78   Nucleic Acids Res. 33(1):W25-W28 (2005) <br>
79   <br>
80   </p>
81 </body>
82 </html>