help/html/webServices/webServicesParams.html

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