JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / ensemblsequencefetcher.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>Fetching ENSEMBL Data in Jalview</title>
24 </head>
25 <body>
26
27   <strong>Fetching ENSEMBL Data in Jalview</strong>
28   <br /> Jalview Version 2.10 (October 2016) introduced support to
29   retrieve annotated transcripts, peptides and genomic contigs from
30   <a href="http://www.ensembl.org">ENSEMBL</a>.
31   <br />
32   <img src="selectfetchdb.gif" align="right" width="480" height="204"
33     alt="Database selection dialog with Ensembl sequence source tooltip">
34
35   <p>Two types of ENSEMBL source are provided. ENSEMBL queries the
36     main ENSEMBL warehouse containing data for higher eukaryotes, and
37     EnsemblGenomes, which queries Ensembl Pathogens, and other
38     warehouses.</p>
39   <p>
40     <strong>General Use</strong><br /> If you have a set of Ensembl
41     gene or transcript IDs, then you can retrieve them <em>via</em> the
42     sequence fetcher dialog opened after selecting the most appropriate
43     source (either 'ENSEMBL', or Ensembl Genomes). However, Jalview's
44     Ensembl client has a couple of additional capabilities:
45   </p>
46   <p>
47     <strong>Retrieving aligned transcripts for a genomic ID</strong>
48   </p>
49   <p>If a single genomic identifier is entered in the Ensembl
50     fetcher, Jalview will return all transcripts and products for the
51     locus, and display them in a split view - complete with sequence
52     variant annotation.</p>
53   <p>
54     <strong>Retrieving orthologs for a gene ID</strong>
55   </p>
56   <p>
57     If a gene ID is entered (e.g. fox1), Jalview will resolve Ensembl
58     genomic identifiers for a predefined set of taxa (Mouse, Rat, Human,
59     Yeast in Jalview 2.10).<br />
60   </p>
61   <p>
62     <strong><a name="ensemblannotation">Ensembl Sequence
63         Features</a></strong><br /> Jalview 2.10 includes support for the
64     visualisation and transfer genomic and transcriptomic sequence
65     features onto protein product sequences. Retrieval of a genomic
66     locus results in a set of transcripts that are annotated with
67     nucleotide variant information and exonic regions. By default,
68     intronic regions will be hidden.
69   </p>
70   <p>
71     <strong><a name="variantvis">Variant information on
72         Protein Products</a></strong><br />Jalview can translate genomic variant
73     annotation into protein sequence variant codes for variants
74     intersecting coding regions of a gene. To see this in action, use
75     the <strong>Calculate&#8594;Show cross-references</strong> menu to
76     view protein product sequences for the currently displayed (or
77     selected) sequences. The same menu allows you to recover Ensembl
78     exon, transcript and variant information when viewing UniProt
79     sequences.
80   </p>
81   <p>
82     <strong>Viewing more information about variant annotation</strong><br />
83     Variants are highlighted as red sequence features on the protein
84     sequence, with each one reporting all protein sequence variants
85     observed at that position as a result of the genomic variants.
86     Right-clicking a variant allows you to open the Ensembl Variants web
87     page for each variant, via the <strong>Link</strong> submenu.
88   </p>
89   <p>
90     <strong>Work in Progress !</strong><br />In the next few releases,
91     we hope to improve and extend Jalview's support for working with
92     Ensembl. If you have any problems, questions or suggestions then
93     please get in contact with us via the Jalview discussion list.
94   </p>
95 </body>
96 </html>