JAL-2189 JAL-1705 JAL-1795 ensembl fetching docs
authorJim Procter <jprocter@issues.jalview.org>
Fri, 16 Sep 2016 19:22:49 +0000 (20:22 +0100)
committerJim Procter <jprocter@issues.jalview.org>
Fri, 16 Sep 2016 19:22:49 +0000 (20:22 +0100)
help/html/features/ensemblsequencefetcher.html [new file with mode: 0644]

diff --git a/help/html/features/ensemblsequencefetcher.html b/help/html/features/ensemblsequencefetcher.html
new file mode 100644 (file)
index 0000000..2a62caa
--- /dev/null
@@ -0,0 +1,56 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>Fetching ENSEMBL Data in Jalview</title>
+</head>
+<body>
+
+  <strong>Fetching ENSEMBL Data in Jalview</strong>
+  <br /> Jalview Version 2.10 (September 2016) introduced support to
+  retrieve annotated transcripts, peptides and genomic contigs from
+  <a href="http://www.ensembl.org">ENSEMBL</a>.
+  <br />
+  <img src="selectfetchdb.gif" align="left" width="480" height="204"
+    alt="Database selection dialog for fetching sequences (introduced in Jalview 2.8)">
+
+  <p>Two types of ENSEMBL source are provided. ENSEMBL queries the
+    main ENSEMBL site, which only serves data for higher eukaryotes, and
+    EnsemblGenomes, which provides access to Ensembl Pathogens, and
+    other warehouses.</p>
+    <p><strong>General Use</strong><br/> If you have a set of Ensembl
+    peptide or transcript IDs, then you can retrieve them
+    <em>via</em> the sequence fetcher dialog opened after selecting the
+    most appropriate source (either 'ENSEMBL', or Ensembl Genomes).
+    However, Jalview's Ensembl client has a couple of additional
+    capabilities: </p><p><strong>Retrieving aligned transcripts for a genomic ID</strong>
+  </p>
+  <p>If a single genomic identifier is entered in the
+    Ensembl fetcher, Jalview will return all transcripts and products
+    for the locus, and display them in a split view - complete with
+    sequence variant annotation.</p>
+  <p><strong>Retrieving orthologs for a gene ID</strong></p>
+  <p>If a gene ID is entered (e.g. fox1), Jalview will resolve
+    Ensembl genomic identifiers for a predefined set of taxa (Mouse,
+    Rat, Human, Yeast in Jalview 2.10).
+    </p>
+</body>
+</html>
\ No newline at end of file