help/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>Jalview can retrieve sequences from a range of sequence, 3D
  30                 structure, genomic and domain family databases provided by EMBL-EBI.</p>
  31         <p>The Sequence Fetcher 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
  34     alignment to import additional sequences. There may be a short delay
  35     when the sequence fetcher is first opened, whilst Jalview contacts each database's web API.</p>
  36   <p>
  37     Every time a new fetcher is opened, you will need to <strong>select
  38       the database you want to retrieve sequences</strong> from the database
  39     chooser.
  40   </p>
  41   <img src="selectfetchdb.gif" align="left"
  42     alt="Database selection dialog for fetching sequences (introduced in Jalview 2.8)">
  43   <p>
  44     The databases are shown as a tree, and ordered alphabetically;
  45     tooltips are shown if you mouse over some sources, explaining what
  46     the database will retrieve. You can select one by using the up/down
  47     arrow keys and hitting return, or by double clicking with the mouse.
  48   </p>
  49   <p>Once you have selected a sequence database, its fetcher dialog
  50     will open. Jalview provides two types of dialog:</p>
  51   <ol>
  52     <li><strong>The Free-text Search Interface</strong> <br />Free-text
  53       search clients are provided for PDB (Since 2.9), and UniProt
  54       (Since 2.10). They provide access to each database's own query
  55       system, enabling you to retrieve data by accession, free text
  56       description, or any other type of supported field. For full
  57       details, see each client's help page:
  58       <ul>
  59         <li><a href="pdbsequencefetcher.html">PDB Sequence
  60             Fetcher</a></li>
  61         <li><a href="uniprotsequencefetcher.html">UniProt
  62             Sequence Fetcher</a></li>
  63       </ul></li>
  64     <li><strong>Accession based sequence retrieval</strong> <br />
  65
  66       <img src="seqfetcher.gif" align="center"
  67       alt="The Jalview Sequence Fetcher Dialog Box"><br /> To
  68       retrieve sequences, simply <strong>enter one or more
  69         accession ids</strong> (as a semi-colon separated list), or press the
  70       &quot;Example&quot; button to paste the example accession for the
  71       currently selected database into the retrieval box. Finally, press
  72       &quot;OK&quot; to initiate the retrieval.
  73       <br />
  74       For the PDB and UniProt sequence fetchers, choose the "Retrieve IDs" tab
  75       to search for accession ids.</li>
  76   </ol>
  77
  78   <p>If you use the Sequence Fetcher, please remember to cite the
  79     corresponding services (linked to below):</p>
  80   <ul>
  81     <li>Ensembl - <a
  82       href="https://github.com/Ensembl/ensembl-rest/wiki#citing">The
  83         Ensembl REST API</a></li>
  84     <li>EMBL/EMBLCDS - Provided by the <a
  85       href="https://www.ebi.ac.uk/ena/browser/api/#/ENA_Browser_Data_API/getFlatFileUsingGET">European
  86         Nucleotide Archive's ENA Data API</a><br />
  87     <em>Note: Versions of Jalview prior to 2.11.1.1 employed the
  88         XML endpoint of the ENA browser, which was retired in August
  89         2020.</em></li>
  90     <li>Uniprot - Free Text Search and Retrieval via the <a
  91       href="https://www.uniprot.org/help/api">Uniprot REST API</a></li>
  92     <li>PDB - Free Text Search via the <a
  93       href="https://www.ebi.ac.uk/pdbe/api/doc/search.html">PDBe
  94         REST API</a> and retrieval via <a
  95       href="https://www.ebi.ac.uk/Tools/dbfetch/">WSDbFetch</a><br />
  96       Pillai S., Silventoinen V., Kallio K., Senger M., Sobhany S., Tate
  97       J., Velankar S., Golovin A., Henrick K., Rice P., Stoehr P., Lopez
  98       R. <br> SOAP-based services provided by the European
  99       Bioinformatics Institute.<br> Nucleic Acids Res.
 100       33(1):W25-W28 (2005) <br> <br>
 101     </li>
 102     <li>
 103       <a href="https://docs.rfam.org/en/latest/citing-rfam.html#rfam-references">RFAM - a database of RNA families</a>
 104     </li>
 105     <li>
 106       <a href="https://pfam-docs.readthedocs.io/en/latest/citing-pfam.html">PFAM - a database of protein families</a><br/>
 107       <a href="https://academic.oup.com/nar/article/49/D1/D344/5958491">Data is provided by the Interpro Web API</a>
 108     </li>
 109   </ul>
 110 </body>
 111 </html>