help/html/webServices/webServicesParams.html

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