Creating Galaxy tool

From BioUML platform
Jump to: navigation, search

If you have BioUML server installed and Galaxy installed, you can add your own tools to BioUML.


Customizing tools menu

If you properly integrated Galaxy with BioUML, Galaxy tools appear in BioUML repository under analyses/Galaxy path. This subtree is populated from Galaxy tool_conf.xml file.

Let's assume that $GALAXY_DIST points to the root folder of Galaxy installation. Look into $GALAXY_DIST/tool_conf.xml file. It contains a number of sections which may contain a number of sections which look like this:

<section name="Section title" id="section_id">
   <tool file="tool/my_tool.xml" />
   <label text="My label" id="my_label"/>
   <tool file="tool/my_other_tool.xml" />

In BioUML interface section is transformed into Type-folder-icon.png folder and label is rendered as a separator between tools. You can freely add, delete or rearrange sections, labels or tools here. To add new tool you should specify a path to the tool description XML file relative to $GALAXY_DIST/tools directory.

Creating your own tool

When you added a link to new tool description XML file, you should create that file. Refer to Galaxy Wiki to learn how to create such files. Please note that not all Galaxy features are supported by BioUML. Ask for technical support if you have any doubts.

BioUML extensions to Galaxy standard

BioUML extends Galaxy tool configuration syntax Galaxy Wiki that allow closer interaction between Galaxy and BioUML systems.

Configurable file format

In Galaxy to define output (<data name="out1" format="tabular"/>) or input parameter (<param type='data' format="tabular"/>) you should set "format" attribute. The list of predefined formats is contained in the $GALAXY_DIST/datatypes_conf.xml and the mapping of these formats to BioUML element types in ru.biosoft.galaxy.types (currently all these mappings are registered in ru.biosoft.galaxy plugin). For more flexibility BioUML allows to change format options "on the fly" when you specify parameter format. For example:

<data name="outTable" format="tabular" format.commentString="#" />

means that lines starting with "#" are comments and should be ignored,

<data name="outTrack" format="interval" format.fieldNames="pValue,FDR" />

set the names of additional columns in the Interval format. In general format options can be changed by adding format.$OptionName="$OptionValue" attributes, the list of possible options for each format is defined by properties of corresponding DataElementImporter or DataElementExporter.

Multiselect parameter type


<param name="inputs" type="data-multi" format="tabular" label="Input tables"/>

In Cheetah template this parameter will be expanded to *.tabular (depending on the format), that can be used in the bash script to get the list of files. For example, to concatenate input files use:

<command>cat $inputs > out<command>

Output name templates

Allow to generate output file names based on other parameter values, such as names of input files. Example:

<data format="vcf" name="output" label="Mapped coordinates" template="$input$_mapped">

where "input" is the name of input parameter.

Reloading tool configuration

Once you finish editing a tool you should reload Galaxy configuration. You can do this using Script viewpart in BioUML interface and typing the following command here:


Please note that for security reasons this command is available for BioUML server administrators only.

Personal tools

BioUML platform
Analysis & Workflows
Collaborative research
Virtual biology