spacer
spacer

Clustal Omega (REST)

Description

Clustal Omega 1) is a multiple sequence alignment program for protein sequences.

For more information see:

Important

We kindly ask all users of EMBL-EBI Web Services to submit tool jobs in batches of up to 30 at a time and to not submit more until the results and processing has completed for these. This enables users as well as the service maintainers to deal more easily with local and remote network outages as well as scheduled or unscheduled downtime.

Service provision happens on a fair-share basis. Overzealous usage of a particular resource will be dealt with in accordance to the EMBL-EBI's Terms of Use.

Clients

Sample clients are provided for a number of programming languages. For details of how to use these clients, download the client and run the program without any arguments.

Language Download Requirements
Perl clustalo_lwp.pl LWP and XML::Simple

For further details of these tool-kits and workflow platforms see our Guide to Web Services.

WADL

The WADL for the Clustal Omega (REST) service: http://www.ebi.ac.uk/Tools/services/rest/clustalo?wadl

Resources

parameters

List parameter names.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/parameters/
Parameters none

Response

An XML document containing a list of parameter names.

For example: http://www.ebi.ac.uk/Tools/services/rest/clustalo/parameters/

parameterdetails

Get detailed information about a parameter.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/parameterdetails/$parameterId
Parameters $parameterId: the name of the parameter

Response

An XML document providing details about the parameter.

For example: http://www.ebi.ac.uk/Tools/services/rest/clustalo/parameterdetails/outfmt.

run

Submit a job with the specified parameters.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/run/
POST email User e-mail address. See Why do you need my e-mail address?
title an optional title for the job.
stype input sequence type
guidetreeout enable/disable output of guide tree (guide tree generation requires that the “mBed-like clustering guide-tree” is disabled)
dismatout enable/disable output of distance matrix (distance matrix generation requires that the “mBed-like clustering guide-tree” is disabled)
dealign enable/disable gap removal for input sequences (de-alignment)
mbed enable/disable mBed-like clustering guide-tree
mbediteration enable/disable mBed-like clustering iteration
iterations number of iterations
gtiterations maximum guild tree iterations
hmmiterations maximum HMM iterations
outfmt output alignment format
sequence sequences to align

More detailed information about each parameter, including valid values can be obtained using the getParameterDetails(parameterId) operation.

Response

A plain text document containing the job identifier.

status

Get the status of a submitted job.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/status/$jobId
Parameters $jobId: job identifier

Response

A plain text document containing the job status.

The values for the status are:

  • RUNNING: the job is currently being processed.
  • FINISHED: job has finished, and the results can then be retrieved.
  • ERROR: an error occurred attempting to get the job status.
  • FAILURE: the job failed.
  • NOT_FOUND: the job cannot be found.

Further details can be found in Synchronous and Asynchronous Access: JDispatcher.

resulttypes

Get available result types for a finished job.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/resulttypes/$jobId
Parameters $jobId: job identifier

Response

An XML document detailing the available result types.

result

Get the job result of the specified type.

Request

URL http://www.ebi.ac.uk/Tools/services/rest/clustalo/result/$jobId/$resultType
Parameters $jobId: job identifier
$resultType: type of result to retrieve. See resulttypes.

Response

A document containing the result in the requested format. The MIME type of the returned document is set according to the format.

1) Sievers F., Wilm A., Dineen D., Gibson T.J., Karplus K., Li W., Lopez R., McWilliam H., Remmert M., Söding J., Thompson J.D. and Higgins D.G. (2011)
Fast, scalable generation of high-quality protein multiple sequence alignments using Clustal Omega.
Mol. Syst. Biol. 7:539
PMID: 21988835
DOI: 10.1038/msb.2011.75
 
services/msa/clustalo_rest.txt · Last modified: 2014/09/05 11:29 by uludag
spacer
spacer