website/man_client.html

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml">\r
   4 \r
   5 <head>\r
   6 <meta name="Last-modified" content="Fri, 28 Jun 2013 12:00:00 GMT"/>\r
   7 <title>Java Bioinformatics Analyses Web Services (JABAWS): Manual</title>\r
   8 <link href="ws.css" rel="stylesheet" type="text/css" media="screen, projection, handheld, tv" />\r
   9 <link href="print.css" rel="stylesheet" type="text/css" media="print" />\r
  10 <link href='http://fonts.googleapis.com/css?family=Yanone+Kaffeesatz:700' rel='stylesheet' type='text/css' />\r
  11 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>\r
  12 </head>\r
  13 \r
  14 <body>\r
  15 <div id="page">\r
  16 \r
  17 <div id="banner">\r
  18 <table>\r
  19   <tr>\r
  20     <td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif" width="158" height="90" alt="University of Dundee" class="logo" title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
  21     <td class="bg"><img src="images/jabaws21.png" width="256" height="67" alt="JABAWS-2.1" title="Java Bioinformatics Analysis Web Services version 2.1"/></td>\r
  22     <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>\r
  23   </tr>\r
  24 </table>\r
  25 </div>\r
  26 <!-- banner end-->\r
  27 \r
  28 \r
  29 <div id="wrapper">\r
  30 <div id="panel">\r
  31         <div id="supermenu">\r
  32         <a class="newa" href="index.html">Home</a> \r
  33         <a class="newa" href="quick_start.html">Getting Started</a> \r
  34         <a class="newpressed" href="man_about.html">Manual</a> \r
  35         </div>\r
  36         <div id="submenu">\r
  37                 <a class="newa" href="man_about.html">About</a>\r
  38                 <a class="newa" href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
  39                 <a class="newa" href="man_awscloud.html" title="JABAWS Server in the Amazon EC2 Cloud">Server in the Cloud</a>\r
  40                 <a class="newa" href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
  41                 <a class="newa" href="man_configuration.html" >Configure JABAWS</a>\r
  42                 <a class="newpressed" href="man_client.html" title="JABAWS Command Line Client">Command Client</a>\r
  43                 <a class="newa" href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>\r
  44                 <a class="newa" href="man_dev.html" title="Accessing JABAWS from your program">Accessing JABAWS</a>\r
  45                 <a class="newa" href="man_server_dev.html" >Develop JABAWS</a>\r
  46         </div>\r
  47 </div>\r
  48 <!-- panel end-->\r
  49 \r
  50 \r
  51 <div id="content">\r
  52 <h2 id="headtitle">JABAWS MANUAL</h2>\r
  53 \r
  54 <h2><a name="usingcclient" id="usingcclient"></a>JABAWS Command Line Client Usage </h2>\r
  55 <p>\r
  56 The command line client comes as a part of <a href="http://www.compbio.dundee.ac.uk/download"> client package</a> which you are welcome to download. \r
  57 The command line client can be used to align sequences using any of JABAWS supported web services. The client is OS independent and supports most of \r
  58 the functions which can be accessed programmatically via <a href="dm_javadoc/index.html">JABAWS API</a>. Using this client you could align sequences \r
  59 using presets or custom parameters, please see examples of this below. Here is the list of options supported by the command line client.\r
  60 </p>\r
  61 <span class="code"><strong>Usage:</strong><br/> java -jar &lt;path_to_jar_file&gt; -h=host_and_context -s=serviceName ACTION [OPTIONS]<br />\r
  62 -h=&lt;host_and_context&gt; - a full URL to the JABAWS web server including context path e.g. http://10.31.10.159:8080/ws<br />\r
  63 -s=&lt;ServiceName&gt; - one of [MafftWS, MuscleWS, ClustalWS, ClustalOWS, TcoffeeWS, ProbconsWS, AAConWS, JronnWS, DisemblWS, GlobPlotWS, IUPredWS]\r
  64 <br/><br/>\r
  65 <strong>ACTIONS:</strong><br/>\r
  66 -i=&lt;inputFile&gt; - full path to fasta formatted sequence file, from which to align sequences<br />\r
  67 -parameters - lists parameters supported by web service<br />\r
  68 -presets - lists presets supported by web service<br />\r
  69 -limits - lists web services limits<br />\r
  70 Please note that if input file is specified other actions are ignored\r
  71 <br/><br/>\r
  72 <strong> OPTIONS:</strong> (only for use with -i action):<br/>\r
  73 -r=&lt;presetName&gt; - name of the preset to use<br />\r
  74 -o=&lt;outputFile&gt; - full path to the file where to write an alignment<br />\r
  75 -f=&lt;parameterInputFile&gt; - the name of the file with the list of parameters to use.<br />\r
  76 Please note that -r and -f options cannot be used together. Alignment is done with either preset or a parameters from the file, but not both!</span>\r
  77 <p>Align sequences from input.fasta file using Mafft web service with default settings, print alignment in Clustal format to console. </p>\r
  78 <p class="code">java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws -s=MafftWS -i=d:\input.fasta</p>\r
  79 <p>Content of input.fasta file is show below (please note sequences has been trimmed for clarity)<span class="code">&gt;Foobar<br />\r
  80   MTADGPRELLQLRAAVRHRPQDFVAWL <br />\r
  81   &gt;Bar<br />\r
  82   MGDTTAGEMAVQRGLALHQ<br />\r
  83   QRHAEAAVLLQQASDAAPE<br />\r
  84   &gt;Foofriend<br />\r
  85   MTADGPRELLQLRAAV</span></p>\r
  86 <p>Align as in above example, but write output alignment in a file out.clustal, using parameters defined in prm.in file</p>\r
  87 <p><span class="code">java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws  -s=MafftWS -i=d:\input.fasta -o=d:\out.clustal -f=prm.in </span></p>\r
  88 <p>The content of the prm.in file is shown below <span class="code">--nofft<br />\r
  89   --noscore<br />\r
  90   --fastaparttree<br />\r
  91   --retree=10<br />\r
  92   --op=2.2</span></p>\r
  93 <p>The format of the file is the same for all JABAWS web services. Parameters are specified in exactly the same way as for native executables - alignment programs like Mafft etc. So parameters which you can use with command line version of an alignment program can be used with JABAWS. Most of the settings controlling alignment process are supported, but because any output has to be handled by JABAWS, settings controlling output are not allowed to be changed. For a list of parameters supported by a web service see the next example. In <span class="hightlight">prm.in</span> parameters are separated by the new line, and name of the parameter is separated from its value with an equals sign. This format is constant no matter which JABAWS web service is used. <br />\r
  94     <span class="code"> java -jar jabaws-min-client.jar -h=http://myhost.compbio.ac.uk:8080/jabaws -s=MafftWS -parameters</span></p>\r
  95 <p>The same client can be used to access JABAWS on different hosts. Just point the client to the host you want to use by changing the value of -h key. For example you used <span class="hightlight">-h=http://myhost.compbio.ac.uk:8080/jabaws</span> server, now you want to use another server to <span class="hightlight">-h=http://mylabserver.myuni.edu.</span> This comes handy if your favorite server is off and you need to do the job yesterday. </p>\r
  96 </div><!-- content end-->\r
  97 <div id="copyright">Last update: 30 April 2014<br/>Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>\r
  98 </div><!-- wrapper end-->\r
  99 </div><!-- page end-->\r
 100 \r
 101 \r
 102 <!-- Google analitics -->\r
 103 <script type="text/javascript">\r
 104 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\r
 105 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\r
 106 </script>\r
 107 <script type="text/javascript">\r
 108 try{\r
 109 var pageTracker = _gat._getTracker("UA-5356328-1");\r
 110 pageTracker._trackPageview();\r
 111 } catch(err) {}\r
 112 </script>\r
 113 </body>\r
 114 </html>\r