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