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