git://source.jalview.org / jalview.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 31048f4)
JAL-2729 draft help pages for HMMER menu
authorgmungoc <g.m.carstairs@dundee.ac.uk>
Fri, 2 Mar 2018 16:07:27 +0000 (16:07 +0000)
committergmungoc <g.m.carstairs@dundee.ac.uk>
Fri, 2 Mar 2018 16:07:27 +0000 (16:07 +0000)
help/help.jhm patch | blob | history
help/helpTOC.xml patch | blob | history
help/html/features/preferences.html patch | blob | history
help/html/menus/alwhmmer.html [new file with mode: 0644] patch | blob

diff --git a/help/help.jhm b/help/help.jhm
index f129193..506b3f3 100755 (executable)
--- a/help/help.jhm
+++ b/help/help.jhm
@@ -126,6 +126,7 @@
    <mapID target="alwCalc" url="html/menus/alwcalculate.html"/>
    
    <mapID target="wsMenu" url="html/menus/wsmenu.html"/>
+   <mapID target="alwHmmer" url="html/menus/alwhmmer.html"/>
    <mapID target="popMenu" url="html/menus/popupMenu.html"/>
    <mapID target="popMenuAddref" url="html/menus/popupMenu.html#addrefannot"/>
    <mapID target="annotPanelMenu" url="html/menus/alwannotationpanel.html"/>
diff --git a/help/helpTOC.xml b/help/helpTOC.xml
index 20dd8db..71b7ef9 100755 (executable)
--- a/help/helpTOC.xml
+++ b/help/helpTOC.xml
@@ -152,6 +152,7 @@
                                <tocitem text="Colour Menu" target="alwColour" />
                                <tocitem text="Calculate Menu" target="alwCalc" />
                                <tocitem text="Web Service Menu" target="wsMenu" />
+                               <tocitem text="HMMER Menu" target="alwHmmer" />
                                <tocitem text="Annotation Panel Menu" target="annotPanelMenu" />
                                <tocitem text="Popup Menu" target="popMenu" />
                        </tocitem>
diff --git a/help/html/features/preferences.html b/help/html/features/preferences.html
index b29b66b..533af5c 100755 (executable)
--- a/help/html/features/preferences.html
+++ b/help/html/features/preferences.html
@@ -62,8 +62,10 @@
       sequence alignments and EPS files.
     </li>
     <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
-        Preferences</a> tab contains settings affecting the export of
-      sequence alignments and EPS files.
+        Preferences</a> tab contains settings affecting the behaviour of alignments as you edit them.
+    </li>
+    <li>The <a href="#hmmer"><strong>&quot;HMMER&quot;</strong>
+        Preferences</a> tab allows you to configure locally installed HMMER tools.
     </li>
     <li>The <a href="dassettings.html"><strong>&quot;DAS
           Settings&quot;</strong> Preferences</a> tab allows you to select which DAS
@@ -387,7 +389,13 @@
     <em>Sort with New Tree</em> - When selected, any trees calculated or
     loaded onto the alignment will automatically sort the alignment.
   </p>
-  <p>&nbsp;</p>
-  <p>&nbsp;</p>
+  <p>
+    <a name="hmmer"><strong>&quot;HMMER&quot; Preferences tab</strong></a>
+  </p>
+  <p>If you have installed HMMER tools (available from <a href="http://hmmerorg">hmmer.org</a>),
+  then you should specify on this screen the location of the installation (the path to the folder 
+  containing binary executable programs). Double-click in the input field to open a file browser.</p>
+  <p>When this path is configured, the <a href="../menus/alwhmmer.html">HMMER menu</a> will be
+  enabled in the Alignment window.</p>
 </body>
 </html>
diff --git a/help/html/menus/alwhmmer.html b/help/html/menus/alwhmmer.html
new file mode 100644 (file)
index 0000000..ce23c4b
--- /dev/null
+++ b/help/html/menus/alwhmmer.html
@@ -0,0 +1,87 @@
+<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>
+</head>
+<body>
+<p>
+  <strong>HMMER Menu</strong>
+</p>
+<p>This menu is available if hmmbuild tools have been installed and configured in the 
+<a href="../features/preferences.html#hmmer">HMMER Preferences</a> panel.
+  <br><br>
+  
+  <strong>hmmbuild</strong>
+  <br><br>Run hmmbuild to create a Hidden Markov Model profile of your sequence alignment or sub-groups.
+  <br><br>The consensus sequence for the computed profile is inserted as the first sequence of
+  the alignment (or group) for which hmmbuild is run.
+  <br>Jalview also computes and displays an annotation below the alignment, showing
+  the information content of each column.
+  <br>This is calculated as the sum over residue symbols of
+  <pre>
+    match emission probability * log(match emission probability / background frequency) / log(2)
+  </pre>
+  where the background frequencies are taken from (tbc: where? not https://www.ebi.ac.uk/uniprot/TrEMBLstats)
+  <ul>
+  <li>Edit settings and run...
+  <br><br>Choose whether to run hmmbuild for the whole alignment, or all or selected groups, or both 
+  (default is the alignment).
+  <br>Optionally enter a name to give the HMM profile consensus sequence
+  (default is "Alignment" or group name, with "_HMM" appended).
+  <br>Use Reference Annotation: select this option if your alignment has an RF reference annotation,
+  and you wish to constrain the HMM profile to it (hmmbuild option '--hand').
+  <br><br></li>
+  <li>hmmbuild with default settings
+  <br><br>Runs hmmbuild for the whole alignment.</li>
+  </ul>
+  
+  <strong>hmmalign</strong> and <strong>hmmsearch</strong> require an HMM consensus sequence to be selected first.
+  <br><em>To do this, right-click on the name of an HMM sequence added by hmmbuild, and 'Select HMM'.
+  The alignment will be with respect to the HMM profile for the consensus sequence.</em>
+  <br><br>
+  <strong>hmmalign</strong>
+  <br><br>Run hmmalign to align selected sequences (or the whole alignment) to a selected HMM profile.
+  <ul>
+  <li>Edit settings and run...
+  <br><br>Choose whether to 'trim non-matching termini' - hmmalign option '--trim'.
+  <br><br></li>
+  <li>hmmalign with default settings</li>
+  </ul>
+  <strong>hmmsearch</strong>
+  <br><br>Run hmmsearch to use an HMM profile as input to search a sequence database.
+  <ul>
+  <li>Edit settings and run...
+  <ul>
+  <li>tbc: choose database</li>
+  <li>tbc: automatically align</li>
+  <li>tbc: return accessions</li>
+  <li>tbc: number of results</li>
+  <li>tbc: sequence eValue cutoff</li>
+  <li>tbc: domains eValue cutoff</li>
+  </ul>
+  </li>
+  <br><li>hmmsearch with default settings</li>
+  <br><li>Add database
+  <br>Browse to select a local sequence data file to be searched</li>
+  </ul>
+<br>
+</body>
+</html>