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