help/html/features/preferences.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>Preferences</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Preferences</strong>
  29   </p>
  30   <p>
  31     The preferences panel is opened from the Jalview Desktop&rsquo;s <strong><em>Tools</em></strong>
  32     menu.
  33   </p>
  34   <p>There are eight tabs in the Preferences dialog box:
  35   <ul>
  36     <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
  37         Preferences</a> tab allows you to configure the default display for
  38       a new alignment window.
  39     </li>
  40     <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
  41         Preferences</a> tab allows you to configure default colourschemes
  42       for a new alignment window.
  43     </li>
  44     <li>The <a href="#structure"><strong>&quot;Structure&quot;</strong>
  45         Preferences</a> tab allows you to configure options for obtaining
  46       and displaying structure information.
  47     </li>
  48     <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
  49         Preferences</a> tab allows you to change the links made from Jalview
  50       to your default web browser.
  51     </li>
  52     <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
  53         Preferences</a> tab contains settings affecting the export of
  54       sequence alignments and EPS files.
  55     </li>
  56     <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
  57         Preferences</a> tab contains settings affecting the export of
  58       sequence alignments and EPS files.
  59     </li>
  60     <li>The <a href="dassettings.html"><strong>&quot;DAS
  61           Settings&quot;</strong> Preferences</a> tab allows you to select which DAS
  62       sources to use when fetching DAS Features.
  63     </li>
  64     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
  65           Service&quot;</strong> Preferences</a> tab allows you to configure the <a
  66       href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
  67       servers that Jalview uses, and change the layout of the
  68       alignment's Web Services menu.
  69     </li>
  70   </ul>
  71   </p>
  72   <p>
  73     <strong><a name="visual">Visual</a> Preferences tab</strong>
  74   </p>
  75   <p>
  76     <em>Maximise Window</em> - If this is selected, a new alignment
  77     window will stretch to fit the available space.
  78   </p>
  79   <p>
  80     <em>Open Overview Window</em> - When this is selected, the <a
  81       href="overview.html">alignment overview</a> panel is opened
  82     by default for a new alignment window.
  83   </p>
  84   <p>
  85     <em>Show Annotations</em> - If this is selected the new window will
  86     display an annotation panel below the sequences. This annotation
  87     panel may have several rows describing the whole alignment. The 3
  88     standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em>
  89     for the alignment may be shown or hidden by default using the
  90     checkboxes below.
  91   </p>
  92   <p>
  93     <em>Show group: Conservation and Consensus</em> controls the display
  94     of per-group automatic annotation.
  95   </p>
  96   <p>
  97     <em>Consensus: Histogram and Logo</em> checkboxes control the
  98     display of the consensus histogram and sequence logo for consensus
  99     annotation rows.
 100   </p>
 101   <p>
 102     <em>Full Sequence ID</em> - If selected the ID panel will display
 103     the name of a sequence plus the start and end residues in the format
 104     name/start-end. If not selected, the displayed ID will be the name
 105     of the sequence.
 106   </p>
 107   <p>
 108     <em>Right Align IDs</em> - select to align all sequence IDs to the
 109     left-hand edge of the sequence alignment, rather than the left-hand
 110     edge of the alignment display window.
 111   </p>
 112   <p>
 113     <em>Font</em> - The default font name, size and style can be set for
 114     a new alignment window.
 115   </p>
 116   <p>
 117     <em>Sequence ID Tooltip</em>: Control the display of Database
 118     References and Non-positional annotation in the tooltip displayed
 119     when the mouse is over a sequence's ID.
 120   </p>
 121   <p>
 122     <em>Show Unconserved</em> - When this is selected, all consensus
 123     sequence symbols will be rendered as a '.', highlighting mutations
 124     in highly conserved alignments.
 125   </p>
 126   <p>
 127     <em>Sequence Name Italics</em> - select to apply the italicised
 128     version of the font to sequence labels.
 129   </p>
 130   <p>
 131     <em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
 132     rendering of the alignment.
 133   </p>
 134   <p>
 135     <em>Gap Symbol</em> - The default gap symbol may be set to either
 136     &quot;-&quot; or &quot;.&quot;
 137   </p>
 138   <p>
 139     <em>Wrap Alignment</em> - Select whether to open new alignment
 140     windows in wrapped mode or not.
 141   </p>
 142   <p>
 143     <em>Sort alignment by</em> - When the alignment is loaded in, it can
 144     be ordered as read (No sort), or sorted by Id or pairwise identity.
 145   </p>
 146   <p>
 147     <em>Sort annotations by</em> - Annotations can be unsorted, sorted
 148     by the order of the related sequences in the alignment, or by label.
 149     Autocalculated annotations (e.g. Consensus) can be shown either last
 150     (below sequence annotations) or first (above sequence annotations).
 151     <em>Since Jalview 2.8.2.</em>
 152   </p>
 153   <p>
 154     <em>Open file</em> - If this is selected then the default alignment
 155     file will be opened when Jalview is started. You can change the
 156     default file by clicking on file name and either typing in the file
 157     path or selecting it from the file chooser window.<br /> <em>Note:
 158       The default example alignment is updated periodically to
 159       demonstrate new features in Jalview.</em>
 160   </p>
 161   <p>
 162     <a name="colours"><strong>&quot;Colours&quot;
 163         Preferences tab</strong>
 164   </p>
 165   <p>
 166     <em>Alignment Colour</em> - The default colour scheme for a new
 167     alignment window. If the chosen option is &quot;User Defined&quot;
 168     then the last User Defined Colour loaded or saved via the User
 169     Defined Colours panel will be loaded.
 170   </p>
 171   <p>
 172     <em>Annotation Shading Default</em> - set the default minimum and
 173     maximum colours used when <a
 174       href="../colourSchemes/annotationColouring.html">Colour
 175       by Annotation...</a> is selected from the alignment window's colours
 176     menu.
 177   </p>
 178   <p>
 179     <a name="structure"><strong>&quot;Structure&quot;
 180         Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
 181   </p>
 182   <p>
 183     <em>Process secondary structure from PDB</em> - if selected, then
 184     structure information read from PDB will be processed and annotation
 185     added to associated sequences.
 186   <p>
 187     <em>Use RNAView for secondary structure</em> - if selected, the
 188     pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>)
 189     will be called to derive secondary structure information for RNA
 190     chains.
 191   <p>
 192     <em>Add secondary structure annotation to alignment</em> - if
 193     selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
 194       implementation DSSP</a> will be used to add annotation to polypeptide
 195     chains in the structure.
 196   <p>
 197     <em>Add Temperature Factor annotation to alignment</em> - if
 198     selected, values extracted from the Temperature Factor column for
 199     the backbone atoms in the PDB file will be extracted as annotation
 200     lines shown on the alignment.
 201   <p>
 202     <em>Default structure viewer</em> - choose JMOL or CHIMERA for
 203     viewing 3D structures.
 204   <p>
 205     <em>Path to Chimera program</em> - Optional, as Jalview will search
 206     standard installation paths for Windows, Linux or MacOS. If you have
 207     installed Chimera in a non-standard location, you can specify it
 208     here, by entering the full path to the Chimera executable program.
 209     Double-click this field to open a file chooser dialog.
 210   <p>
 211     <a name="connections"><strong>&quot;Connections&quot;
 212         Preferences tab</strong></a>
 213   </p>
 214   <p>
 215     <em>URL Link From Sequence ID</em><br> These definitions are
 216     used to generate URLs from a sequence's ID or database cross
 217     references. Read more about <a
 218       href="../webServices/urllinks.html#urllinks">configuring
 219       URL links here</a>.
 220   </p>
 221   <p>
 222     <em>Default Browser (Unix)</em><br> Its difficult in Java to
 223     detect the default web browser for Unix users. If Jalview can't find
 224     your default web browser, enter the name or full path to your web
 225     browser application.
 226   </p>
 227   <p>
 228     <em>Proxy Server</em><br> If you normally use a proxy server
 229     for using the internet, you must tick the box &quot;Use a Proxy
 230     Server&quot; and enter the address and port details as necessary.
 231     Web Services will not work if you are using a proxy server and do
 232     not enter the settings here.
 233   </p>
 234   <p>
 235     <em>Usage statistics, Questionnaire and Version checks</em><br>
 236     Uncheck these options to prevent Jalview from submitting usage
 237     statistics to google analytics, checking for Jalview questionnaires
 238     or retrieving details of the latest release version (at
 239     www.jalview.org). See the <a href="../privacy.html">user privacy
 240       statement</a> for more information.
 241   </p>
 242   <p>
 243     <a name="output"><strong>Output Preferences tab</strong></a>
 244   </p>
 245   <p>
 246     <em>EPS Rendering Style</em><br> This is a selection box which
 247     allows the user to set a default rendering style for EPS export:
 248   <ul>
 249     <li>&quot;Prompt each time&quot;<br> Choose this to be
 250       asked select between Lineart and Text each time you make an EPS
 251       file.
 252     </li>
 253     <li>&quot;Lineart&quot;<br> EPS files will accurately
 254       reproduce the alignment view in Jalview and all characters will be
 255       converted into line art. Files generated in this way are large and
 256       are not easily editable, but have no font table dependencies.
 257     </li>
 258     <li>&quot;Text&quot;<br> EPS files will be a mixture of
 259       text and lineart. This produces compact files that can be edited
 260       easily in programs like Microsoft Word and Adobe Illustrator, but
 261       can be problematic if the fonts available to Jalview are not
 262       accessible by the program reading the EPS file.
 263   </ul>
 264   <p>
 265     <em>Automatically set ID width</em><br> When enabled, the
 266     column containing sequence and annotation labels at the left hand
 267     side of an exported figure will be made large enough to display each
 268     sequence ID and annotation label in its own line. Enable this if you
 269     have particularly long sequence IDs and need to generate EPS or PNG
 270     figures or web pages.
 271   </p>
 272   <p>
 273     <em>Figure ID column width</em><br> Manually specify the width
 274     of the left hand column where sequence IDs and annotation labels
 275     will be rendered in exported alignment figures. This setting will be
 276     ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
 277   </p>
 278   <p>
 279     <em>Sequence//Start-End Numbering</em><br> The output tab also
 280     has a group of checkboxes for each file format. If these are ticked,
 281     then Jalview will write files with the start and end sequence
 282     positions appended to each sequence id:
 283   <pre>
 284   >ID/1-10
 285   AACDEAAFEA
 286 </pre>
 287   <p>If the boxes are left unchecked for a particular format, the
 288     sequence limits will not be appended to the sequence id.</p>
 289   <p>
 290     <em>Embed BioJSON to HTML export</em>
 291   </p>
 292   <p>
 293     When this option is enabled, Jalview embeds <a
 294       href="bioJsonFormat.html">BioJSON</a> data within HTML files
 295     exported from Jalview at generation time. This enables the exported
 296     HTML files to be extracted and imported back into the Jalview
 297     desktop application at a later time.
 298   <p>
 299     <em>Use Modeller Output</em>
 300   </p>
 301   <p>
 302     This option only applies to PIR format output. Jalview automatically
 303     reads PIR files with sequence descriptions compatible with the
 304     program <a href="http://salilab.org/modeller/">Modeller</a>. If this
 305     option is selected <a href="../io/modellerpir.html">Jalview will
 306       write Modeller style PIR files</a> with correct start/end numbering
 307     and PDB file association (if available). The Jalview id/start-end
 308     option is ignored if Modeller output is selected.
 309   <p>
 310     <a name="editing"><strong>Editing Preferences tab</strong></a>
 311   </p>
 312   <p>There are currently three options available which can be
 313     selected / deselected.</p>
 314   <p>
 315     <em>AutoCalculate Consensus</em> - For large alignments it can be
 316     useful to deselect &quot;Autocalculate Consensus&quot; when editing.
 317     This prevents lengthy calculations which are performed after each
 318     sequence edit. New alignment windows will have their
 319     &quot;Autocalculate Consensus&quot; option set according to this
 320     setting.
 321   </p>
 322   <p>
 323     <em>Pad Gaps when Editing</em> - New alignment windows will
 324     &quot;Pad Gaps&quot; according to this setting.
 325   </p>
 326   <p>
 327     <em>Sort with New Tree</em> - When selected, any trees calculated or
 328     loaded onto the alignment will automatically sort the alignment.
 329   </p>
 330   <p>&nbsp;</p>
 331   <p>&nbsp;</p>
 332 </body>
 333 </html>