Page tree
Skip to end of metadata
Go to start of metadata

Contents

Introduction

A program to translate nucleic acid sequences to their corresponding peptide sequences. It can translate to the three forward and three reverse frames, and output multiple frame translations at once.

Official Website

Download Software

Important Note

  • We kindly ask all users of EMBL-EBI Web Services to submit tool jobs in batches of no more than 30 at a time and not to submit more until the results and processing is complete. Please ensure that a valid email address is provided. Excessive usage of a particular resource will be dealt with in accordance with EMBL-EBI's Terms of Use. Please contact us if you need further information.

How to Access EMBOSS transeq

EMBOSS transeq can be accessed via

Web Form

Web interface for EMBOSS transeq is available at : https://www.ebi.ac.uk/Tools/st/emboss_transeq/

How to use this tool

Running a tool from the web form is a simple multiple steps process, starting at the top of the page and following the steps to the bottom.

Each tool has at least 2 steps, but most of them have more:

  • The first steps are usually where the user sets the tool input (e.g. sequences, databases...)
  • In the following steps, the user has the possibility to change the default tool parameters
  • And finally, the last step is always the tool submission step, where the user can specify a title to be associated with the results and an email address for email notification. Using the submit button will effectively submit the information specified previously in the form to launch the tool on the server

Note that the parameters are validated prior to launching the tool on the server and in the event of a missing or wrong combination of parameters, the user will be notified directly in the form.

Step 1 - Input Sequences

Input Sequence

One or more nucleic acid sequences to be translated can be entered directly into this form. Any input formats accepted by EMBOSS can be used, the full list of sequence formats accepted as input by EMBOSS tools is given in this table: EMBOSS sequence formats. Adding a return to the end of the sequence may help certain applications understand the input. Note that directly using data from word processors may yield unpredictable results as hidden/control characters may be present.

Sequence File Upload

A file containing one or more valid sequences in any EMBOSS accepted format can be uploaded and used as input for the translation. The full list of sequence formats accepted as input by EMBOSS tools is given in this table: EMBOSS sequence formats. Word processor files may yield unpredictable results as hidden/control characters may be present in the files. It is best to save files with the Unix format option to avoid hidden Windows characters.

Step 2 - Select parameters

Frame

The frames to be translated. The order of the frames follows the Staden convention: Frame -1 is the reverse-complement of the sequence having the same codon phase as frame 1. Frame -2 is the same phase as frame 2. Frame -3 is the same phase as frame 3.

FrameValue
11
22
33
F (Forward three frames)F
-1-1
-2-2
-3-3
R (Reverse three frames)R
6 (All six frames)6

Default value is: 1

Codon Table

Which genetic code table to use. These are kept synchronised with those maintained at the NCBI's Taxonomy Browser.

Table nameValue
Standard Code0
Vertebrate Mitochondrial2
Yeast Mitochondrial3
Mold, Protozoan, Coelenterate Mitochondrial and Mycoplasma/Spiroplasma4
Invertebrate Mitochondrial5
Ciliate Macronuclear and Dasycladacean6
Echinoderm Mitochondrial9
Euplotid Nuclear10
Bacterial11
Alternative Yeast Nuclear12
Ascidian Mitochondrial13
Flatworm Mitochondrial14
Blepharisma Macronuclear15
Chlorophycean Mitochondrial16
Trematode Mitochondrial21
Scenedesmus obliquus22
Thraustochytrium Mitochondrial23

Default value is: Standard Code [0]

Regions

Which regions of the user's DNA molecule are to be translated.

Default value is: START-END

Trim

Remove "*" and "X" (stop and ambiguity) symbols from the end of the translation.

Default value is: no [false]

Reverse

Choose this option if you wish to reverse and complement your input sequence before frame translation.

Default value is: no [false]


Example output formats

Step 3 - Submission

Job title

It's possible to identify the tool result by giving it a name. This name will be associated to the results and might appear in some of the graphical representations of the results.

Email Notification

Running a tool is usually an interactive process, the results are delivered directly to the browser when they become available. Depending on the tool and its input parameters, this may take quite a long time. It's possible to be notified by email when the job is finished by simply ticking the box "Be notified by email". An email with a link to the results will be sent to the email address specified in the corresponding text box. Email notifications require valid email addresses.

Email Address

If email notification is requested, then a valid Internet email address in the form joe@example.org must be provided. This is not required when running the tool interactively (The results will be delivered to the browser window when they are ready).

Top


Web Services

Web Services are available using REST and SOAP protocols that enable programmatic access and allow their integration into other applications and analytical workflows and pipelines. 

For an introduction on how to run these clients and use them in workflows please see the webinar series.


REST API

The Representational State Transfer (REST) 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.

LanguageDownloadRequirements
Perlemboss_transeq.plLWP and XML::Simple

Python

emboss_transeq.py

xmltramp2

For details see Environment setup for REST Web Services and Examples for Perl REST Web Services Clients pages.

WADL

The WADL for the EMBOSS transeq (REST) service: http://www.ebi.ac.uk/Tools/services/rest/emboss_transeq?wadl

Tool Parameters

Parameters

Command line parameter
FRAME--frame
CODON TABLE--codontable
REGIONS--regions
TRIM--trim
REVERSE--reverse

Top


SOAP API

The Simple Object Access Protocol (SOAP) 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.

WSDL

The WSDL for the EMBOSS transeq (SOAP) service: http://www.ebi.ac.uk/Tools/services/soap/emboss_transeq?wsdl


 List Methods
MethodsDescriptionArgumentsReturns

getParameters()

Get a list of the parameter names.nonea list of strings giving the names of the parameters.

getParameterDetails(parameterId)

Get details of a specific parameter.parameterId: identifier/name of the parameter to fetch details of.a wsParameterDetails describing the parameter and its values.

run(email, title, params)

Submit a job to the service.
  • email: (required) user e-mail address. See Why do you need my e-mail address?

  • title: job title. Default: ””.

  • params: (required) parameters for the tool. These are described by the InputParameters data structure.

a string containing the job identifier (jobId).

getStatus(jobId)

Get the status of a submitted job.jobId: (required) job identifier.

a string containing the 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.

getResultTypes(jobId)

Get the available result types for a finished job.jobId: (required) job identifier.a list of wsResultType data structures describing the available result types.

getResult(jobId, type, parameters)

Get the result of a job of the specified type.
  • jobId: (required) job identifier.

  • type: (required) string specifying the result type to fetch. See getResultTypes(jobId) for details of the available types.

  • parameters: optional list of wsRawOutputParameter used to provide additional parameters for derived result types.

Returns: the result data for the specified type, base64 encoded. Depending on the SOAP library and programming language used the result may be returned in decoded form. For some result types (e.g. images) this will be binary data rather than a text string.
 List Datatypes

InputParameters

The input parameters for the job:

AttributeTypeDescription
framestringTranslation frames.
codontablestringGenetic code table.
regionsstringDNA Regions to be translated.
trimbooleanRemove “*” and “X” (stop and ambiguity) symbols from the end of the translation.
reversebooleanReverse and complement input sequence.
sequencestringInput sequence.

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

wsParameterDetails

Descriptive information about a tool parameter. Returned by getParameterDetails(parameterId).

AttributeTypeDescription
namestringName of the parameter.
descriptionstringDescription of the parameter, suitable for use in option help interfaces.
typestringData type of the parameter.
valueslist of wsParameterValueList of valid values for the option.

wsParameterValue

Description of a tool parameter value. Used in wsParameterDetails.

AttributeTypeDescription
labelstringDisplay name of the value, for use in interfaces.
valuestringString representation of the value to be passed to the tool parameter.
defaultValuebooleanFlag indicating if this value is the default.
propertieslist of wsPropertyList of key/value pairs providing further information.

wsProperty

Properties of a tool parameter value. Used in wsParameterValue.

AttributeTypeDescription
keystringProperty name
valuestringProperty value

wsRawOutputParameter

Additional parameters passed when requesting a result. See getResult(jobId, type, parameters).

AttributeTypeDescription
namestringParameter name
valuelist of stringParameter value

wsResultType

Description of a result type. Returned by getResultTypes(jobId).

AttributeTypeDescription
identifierstringIdentifier for the result type. Passed as type to getResult(jobId, type, parameters).
labelstringDisplay name for use in user interfaces.
descriptionstringDescription of the result type, for use in help interfaces.
mediaTypestringMIME type of the returned data.
fileSuffixstringSuggested suffix for file name, if writing data to disk.

Top


Open API Interface

https://www.ebi.ac.uk/Tools/common/tools/help/index.html?tool=emboss_transeq


 List Endpoints

Endpoints

DescriptionArgumentsReturns
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameters
Get a list of the parameter names.noneA list of strings giving the names of the parameters.

https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/frame
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/codontable
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/regions
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/trim
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/reverse
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/parameterdetails/sequence
Get details of a specific parameter.parameterdetail: identifier/name of the parameter to fetch details of.A wsParameterDetails describing the parameter and its values.
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/run
Submit a job to the service.

email: (required) user e-mail address. See Why do you need my e-mail address?

title: job title. Default: ””.

params: (required) parameters for the tool. These are described by the InputParameters data structure.

A string containing the job identifier (jobId).
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/status/<jobid>
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/resulttypes/<jobid>

Get the status of a submitted job.jobId: (required) job identifier.

A string containing the 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: Job Dispatcher.

https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/resulttypes/<jobid>
Get the available result types for a finished job.

jobId: (required) job identifier.

Returns: a list of wsResultType data structures describing the available result types.
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/result/<jobid>/out
https://www.ebi.ac.uk/Tools/services/rest/emboss_transeq/result/<jobid>/sequence
Get the result of a job of the specified type.

jobId: (required) job identifier.

type: (required) string specifying the result type to fetch. See getResultTypes(jobId) for details of the available types.

parameters: optional list of wsRawOutputParameter used to provide additional parameters for derived result types.

Returns: the result data for the specified type, base64 encoded. Depending on the SOAP library and programming language used the result may be returned in decoded form. For some result types (e.g. images) this will be binary data rather than a text string.

Top


Common Workflow Language

CWL (Common Workflow Language) implementation for consuming EMBL-EBI Bioinformatics Web Services tools' clients are available at https://github.com/ebi-wp/webservice-cwl

For details, see CWL Workflows page. 

Top


Reference 

EMBOSS

EBI  Web Services

  • No labels