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