help/html/webServices/webServicesParams.html

   1
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19 <html>
  20 <head>
  21 <title>Web Service Job Parameter Dialog Box</title>
  22 </head>
  23 <body>
  24 <p><strong>Web service Job Parameter Dialog box</strong></p>
  25
  26 <p>Some Jalview services including those provided by <a
  27         href="JABAWS.html">JABAWS</a>, support a range of parameters and
  28 options, enabling you to employ the most appropriate settings for the
  29 input data. In addition to any preset combinations provided by the
  30 services themselves, the Web services parameters dialog box also allows
  31 you to create and store your own parameter sets, so they can be accessed
  32 quickly from the presets menu.</p>
  33 <p><Strong>Accessing the parameter dialog box</Strong><br>
  34 The parameters dialog box is opened by selecting the 'Edit and Run' menu
  35 entries within the JABAWS analysis submenu of the alignment window's web
  36 services menu. Once opened, it presents the parameters and options
  37 available for the chosen analysis for you to modify, and and also
  38 enables you to browse any available service presets and select, create
  39 or modify your own user defined parameter sets. Once you are satisfied
  40 with the analysis parameters, press the <strong>Start Job</strong>
  41 button to initiate the analysis.</p>
  42 <p><Strong>Getting help on the analysis parameters</Strong><br>
  43 Each option or parameter shown in the dialog is accompanied by a brief
  44 description, which is shown as a tooltip when the mouse is moved over
  45 it. For some, a link symbol will also be shown (as in the example
  46 below), indicating that further information is available online. In this
  47 case, right-clicking (or command-click) will open a pop-up menu allowing
  48 you to select a URL to open in your web browser.</p>
  49 <p>
  50 <center><img src="wsparams.gif" align="center" width="480"
  51         height="499" alt="Analysis Parameters Dialog Box for JABAWS Services">
  52 <br>
  53 Parameter settings dialog box for JABAWS MAFFT Service</center>
  54 </p>
  55 <p>The menu and text box at the top of the dialog box displays the
  56 name of the current parameter set. The name can be edited, should you
  57 wish to change or create a new user defined set, or clicked to present a
  58 menu enabling other sets to be browsed. The description shown below may
  59 also be edited (and the box resized to facilitate this), allowing you to
  60 provide notes to accompany the parameter set. The modification of these
  61 or any of the option or parameter settings will enable one or more of
  62 the following buttons, that allow you to:
  63 <ul>
  64         <li><em>Revert</em> the changes you have made. This will undo any
  65         changes you have made to the parameters and options with respect to the
  66         currently selected parameter set, reverting each setting to its default
  67         or last saved value.</li>
  68         <li><em>Create</em> a new parameter set. Selecting this option
  69         will create a new parameter set with the given name. New parameter sets
  70         will be saved for the current session, but a file chooser will also
  71         open which gives you the option to save the set for use in future
  72         sessions.</li>
  73         <li><em>Update</em> an existing user defined parameter set. This
  74         button will save any modifications you have made to the current
  75         parameter set.</li>
  76         <li><em>Rename</em> the current user defined parameter set. This
  77         will update the name recorded for the current parameter set.</li>
  78         <li><em>Delete</em> the current parameter set. Selecting this will
  79         erase the current user defined parameter set from memory, and delete
  80         its associated parameter file (if it exists).</li>
  81 </ul>
  82 </p>
  83 <p><em>Support for adjusting and saving web service parameter
  84 sets was added in Jalview 2.6</em></p>
  85 </body>
  86 </html>