annotate data_manager_build_alfa_indexes/data_manager/data_manager_build_alfa_indexes.xml @ 0:f68a60c3d768 draft default tip

Uploaded
author biocomp-ibens
date Wed, 16 May 2018 09:56:43 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
1 <tool id="build_alfa_indexes" name="ALFA indexes" version="0.0.1" tool_type="manage_data">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
2 <description>build ALFA indexes from automatically downloaded gtf annotation file</description>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
3 <!-- ALFA requires bedtools suite v2.20.0 and above -->
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
4 <requirements>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
5 <requirement type="package" version="2.24">bedtools</requirement>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
6 <requirement type="package" version="1.2">samtools</requirement>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
7 <requirement type="package" version="1.4">matplotlib</requirement>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
8 </requirements>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
9
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
10 <command interpreter="python">data_manager_build_alfa_indexes.py -e "${reference_source['kingdom']}" "${reference_source['species_name']}" -o "${out_file}" "$__tool_directory__"</command>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
11
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
12 <inputs>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
13 <conditional name="reference_source">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
14 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
15 <option value="ensembl" selected="True">Ensembl Genomes Websites</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
16 </param>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
17 <when value="ensembl">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
18 <param name="kingdom" type="select" label="Select the ensembl website where to fetch the genome">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
19 <option value="vertebrates" selected="True">Ensembl (Vertebrates)</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
20 <option value="bacteria" selected="True">Ensembl Bacteria</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
21 <option value="fungi" selected="True">Ensembl Fungi</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
22 <option value="metazoa" selected="True">Ensembl Metazoa</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
23 <option value="plants" selected="True">Ensembl Plants</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
24 <option value="protists" selected="True">Ensembl Protists</option>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
25 </param>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
26 <param name="species_name" type="text" value="Homo sapiens" label="Complete Species_Name" optional="False">
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
27 <validator type="empty_field" message="Please, enter a species name."/>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
28 </param>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
29 </when>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
30 </conditional>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
31 </inputs>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
32
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
33 <outputs>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
34 <data name="out_file" format="data_manager_json"/>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
35 </outputs>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
36
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
37 <help>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
38 <![CDATA[
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
39 **What it does**
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
40
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
41
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
42 | 1. The tool asks the admin to enter a *species_name* and automatically download the last release of the corresponding gtf annotation file on Ensembl.
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
43 |
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
44 | 2. The tool calls ALFA.py to generate the alfa indexes from this gtf file.
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
45 |
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
46 | 3. Resulting indexes are stored in the child directory *alfa_indexes/* of the dir *<galaxy_data_manager_data_path>* defined in *config/galaxy.ini*
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
47 |
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
48 | 4. Finally, the tool adds the new entry to the table *alfa_indexes.loc*. This .loc file is where the data table *alfa_indexes* points, as defined in *config/shed_tool_data_table.conf.xml*
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
49 |
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
50 | 5. At the end of the process, when a user will use `alfa`_ , the built-in indexes corresponding to the *species_name* will be available
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
51
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
52 .. _alfa: https://toolshed.g2.bx.psu.edu/view/charles-bernard/alfa
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
53
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
54 ]]>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
55 </help>
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
56
f68a60c3d768 Uploaded
biocomp-ibens
parents:
diff changeset
57 </tool>