JABAWS MANUAL
About
@@ -45,40 +56,174 @@ class="headeru">ServicesWhat is JABAWS?
-JABAWS stands for JAva Bioinformatics Analysis Web Services. It is a collection of web services for multiple sequence alignment. For simplicity we referrer to them as JABAWS. Right now, JABAWS makes it easy to access well-known multiple sequence alignment programs from JalView. However, the scope of JABAWS is not limited to multiple sequence alignment programs. Future versions of JABAWS will incorporate protein disorder prediction, BLAST, PSIBLAST and HMMER database searches and many other tools. For the list of currently supported programs see here. JABAWS consists of the two parts - the server and the client. Unlike other web services you can download and use both on your own computer! If you want a server just for yourself, then download and install JABAWS Virtual Appliance. It requires no configuration and simple to install. If you want to install JABAWS for your own lab then download JABAWS Web Application aRchive. It is slightly more complicated to configure but is very straightforward too. Finally, if you want to script against any version of JABAWS or interested in writing your own client, the JABAWS command line client is what you need.
++ JABAWS stands for JAva Bioinformatics Analysis Web Services. As the name suggests, JABAWS is a + collection of web services for bioinformatics, and currently provides services that make it easy + to access well-known multiple sequence alignment and protein disorder prediction programs + (see the list of currently supported programs) from Jalview. + Future versions of JABAWS will incorporate other tools. +
+Getting JABAWS
++ JABAWS consists of a server and a client, but unlike most bioinformatics web service systems, you can download and + run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS + Virtual Appliance. It requires no configuration and is simple to install. If you want to install JABAWS for your + lab or institution then download the JABAWS Web Application aRchive. It is slightly more complicated to configure + but is very straightforward too. Finally, if you want to script against any version of JABAWS or are interested + in writing your own client, the JABAWS command line client is what you need. +
+ + +JABAWS Benefits
-JABAWS can be deployed on many operating system and operate as a stand alone server or submit the jobs to the cluster. Thanks to DRMAA it integrates well with a large variety of cluster job management systems. Jalview from version 2.6 integrates with JABAWS and can be configured to submit jobs to different versions of JABAWS, for example to your local, lab version, or publicly available version elsewhere. As JABAWS can be installed in your lab, or indeed on your personal computer, it eliminates the need to send your private information to the outside, to one of the publicly accessible servers. JABAWS can run programs with additional parameters defined by you, so you are no longer limited to defaults. JABAWS is safe to install for public access as it could limit the size of the tasks which it accepts and denies access to resources within web application folder.
+-
+
- Can be deployed on most operating systems, as a VMware or other compatible Virtual Appliance or a Tomcat Java Web Application. +
- Comes complete with sources and binaries for all the bioinformatics programs that it runs. +
- Can operate as a stand alone server or one that submits jobs to a cluster via DRMAA. +
- Easy to access from Jalview using its graphical client, or using the JABAWS command line client. +
- Clients can submit jobs to any JABAWS servers that they might want to access, such as the one running on your local computer, + your lab's server, or the publicly available services at the University of Dundee. +
- Local or intranet installation eliminates any security concerns you might have about sending sensitive data over the internet. +
- Wide range of configuration options to control size of jobs accepted by a server, and the command line options available for the program run by a service. +
JABA Web Services Programs
-JABAWS currently uses the following programs under the hood
+JABAWS currently provides access to the following programs:
+Multiple Sequence Alignement
+-
+
- Clustal Omega (version 1.0.2) +
- ClustalW (version 2.52) +
- Mafft (version 6.857) +
- Muscle (version 3.8.31) +
- Tcoffee (version 8.99) +
- Probcons (version 1.12) +
- MSAProbs (version 0.9.7) +
- GLProbs (version 0.9.7) +
Protein Secondary structure prediction
+-
+
- Jpred (3.0.3) +
Protein disorder prediction
-
-
- ClustalW (version 2.0.12) -
- Mafft (version 6.713) -
- Muscle (version 3.7) -
- Tcoffee (version 8.14) -
- Probcons (version 1.12) +
- DisEMBL (1.5) +
- IUPred (1.0) +
- Jronn - Java implementation of Ronn (3.1) +
- GlobPlot (2.3)
Amino Acid conservation
+-
+
- AACon (1.0) +
Secondary structure for an RNA aligment
+-
+
- RNAalifold from ViennaRNA (2.0) +
What is new in JABAWS 2.1?
+JABAWS Version 2.1 (Released 1st Oct 2013) +Several new web services are available in this version of JABAWS:
+-
+
- Two multiple sequence aligners (MSAprobs and GLprobs), both services return the standard Alignment object +
- RNAalifoldWS returns RNAStructScoreManager, which is the standard ScoreManager objects with several additional methods +
- + JpredWS returns the JpredAligment object, which is the standard alignment with additional methods for extracting + Jpred predictions. These predictions are supplied as additional sequences in the aligment + +
Some bugs have been fixed and several improvements have been done:
+-
+
- WS status servlet returns version and some additional information on each web service +
- a bug with path to help in the client +
- Fix two bug with the Google Analytics library: no-stop due to running thread +
- GoogleAnalytics gets proper JABAWS version +
JABAWS 2.0.1 includes several bug fixes and minor updates for JABAWS Version 2.0. These are listed below:
+-
+
- Disembl returned swapped strings for HOTLOOPS and REM465 +
- Jronn failed to process jobs with more than 3 sequences +
- JABAWS could not deal with FASTA records with '>' symbols in the record identificator +
- Change of parameter description for AAcon: parameters have been replaced with options for calculation methods. This allows a user to get several AAcon's conservation scores + in one call +
- JABAWS never cleaned up job directories. Now JABAWS deletes the job directory if it exist longer than a period defined in Engine.properties +
- Default web security has been incompatible with Tomcat 7.0.31 and newer +
- Documentation has been updated +
Compared to JABAWS 1, JABAWS 2 offers a greater number and diversity of web services, Amazon EC2 integration and improved ease of use.
It contains:
+- updates for all multiple sequence alignment services +
- four new protein disorder prediction services +
- Clustal Omega multiple sequence alignment web service +
- amino acid conservation service +
- web services execution statistics visualization +
- web services status check from a web page +
- VirtualBox support was dropped in favour of VMware +
- new WAR package for Mac users +
- Amazon Machine Image (AMI) distributive to enable users to use JABAWS on the EC2 cloud +
- Improved web services client API +
- Simplified WAR package installation +
What is JABAWS Server?
-JABAWS Server is a Web Application which exposes a number of widely used Bioinformatics programs as SOAP web services. Currently it supports 5 multiple sequence alignment programs. You can download and install JABAWS on your own computer. JABAWS can be configured to execute programs on computer it is installed or submit them to the cluster. JABAWS provides the uniform API for each web service if supports.
What is JABAWS client?
-JABAWS client is a command line Java application which can call all JABAWS methods on any instance of JABAWS Server, no matter local or remote. It is useful if you want to script against a JABAWS server and do not want to handle any web service specific details. We also offer a source code of the client so that you can find out how to work with JABA Web Services if you would like to write your own client software. JABAWS command line client offers the same functionality as Jalview when connected to JABAWS.
++ A JABAWS client is a Java application that lets you run the programs for which a JABAWS server provides web + services. The most basic JABAWS client is a command line application this is able to call any of the JABAWS web + services on any instance of JABAWS Server available over the web. The basic client is useful if you would like + to test or execute the programs provided by theJABAWS server in your own scripts, but you do not want to handle + any web service specific details. The client is an open source software, so you can also use the source code to + as an example how to manipulate with JABAWS web services in your own code. + Jalview, a multiple sequence alignment and analysis application, is a good + example of a graphical JABAWS client. This client uses the same functionality as the command line client, but + instead allows JABAWS services to be accessed in a more user-friendly manner, through a graphical user interface. +
+ + + +JABAWS versions compatibility and Jalview support
++ JABAWS version 2.1 is fully backward compatible with JABAWS v1.0 and v2.0. This means all JABAWS 1.0 and 2.0 and + 2.0.1 clients should also be able to use JABAWS 2.1 services. To access the analysis web services introduced in + JABAWS 2.0, however, clients that were designed for JABAWS v1.0 must be updated. +
+ + +Programmatic access to JABAWS
-JABA Web Services are WS-I basic profile compliant, they can be accessed in a standard way as any other web service. The WSDL for each service is published on the JABAWS home page. If you use Java, then you can use our client package to access JABAWS. This package contains value objects which you could alternatively generate with wsimport in Java, or similar tool in other language. On top of that it offers some additional methods which further simplify working with JABAWS. For more information please refer to the data model javadoc.
-