annotate get_flanks.xml @ 4:077f404ae1bb draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
author devteam
date Thu, 22 Jun 2017 18:41:29 -0400
parents 4cd116158aef
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
c3b1781c6fd1 Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="get_flanks1" name="Get flanks" version="1.0.0">
4
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
2 <description>returns flanking region/s for every gene</description>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
3 <macros>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
4 <import>macros.xml</import>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
5 </macros>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
6 <expand macro="requirements" />
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
7 <command><![CDATA[
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
8 python '$__tool_directory__/get_flanks.py'
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
9 '$input'
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
10 '$out_file1'
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
11 $size
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
12 $direction
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
13 $region
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
14 -o $offset
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
15 -l ${input.metadata.chromCol},${input.metadata.startCol},${input.metadata.endCol},${input.metadata.strandCol}
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
16 ]]></command>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
17 <inputs>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
18 <param name="input" type="data" format="interval" label="Select data"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
19 <param name="region" type="select" label="Region">
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
20 <option value="whole" selected="true">Whole feature</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
21 <option value="start">Around Start</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
22 <option value="end">Around End</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
23 </param>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
24 <param name="direction" type="select" label="Location of the flanking region/s">
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
25 <option value="Upstream">Upstream</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
26 <option value="Downstream">Downstream</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
27 <option value="Both">Both</option>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
28 </param>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
29 <param name="offset" type="integer" value="0" label="Offset" help="Use positive values to offset co-ordinates in the direction of transcription and negative values to offset in the opposite direction."/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
30 <param name="size" type="integer" value="50" label="Length of the flanking region(s)" help="Use non-negative value for length"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
31 </inputs>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
32 <outputs>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
33 <data name="out_file1" format_source="input" metadata_source="input"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
34 </outputs>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
35 <tests>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
36 <test>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
37 <param name="input" value="flanks_inp.bed"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
38 <param name="offset" value="-500"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
39 <param name="size" value="1000"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
40 <param name="direction" value="Both"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
41 <param name="region" value="whole"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
42 <output name="out_file1" file="flanks_out1.bed"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
43 </test>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
44 <test>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
45 <param name="input" value="flanks_inp.bed"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
46 <param name="offset" value="200"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
47 <param name="size" value="1000"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
48 <param name="direction" value="Downstream"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
49 <param name="region" value="start" />
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
50 <output name="out_file1" file="flanks_out2.bed"/>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
51 </test>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
52 </tests>
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
53 <help><![CDATA[
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
54 This tool finds the upstream and/or downstream flanking region(s) of all the selected regions in the input file.
0
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
55
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
56 **Note:** Every line should contain at least 3 columns: Chromosome number, Start and Stop co-ordinates. If any of these columns is missing or if start and stop co-ordinates are not numerical, the tool may encounter exceptions and such lines are skipped as invalid. The number of invalid skipped lines is documented in the resulting history item as a "Data issue".
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
57
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
58 -----
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
59
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
60 **Example 1**
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
61
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
62 - For the following dataset::
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
63
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
64 chr22 1000 7000 NM_174568 0 +
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
65
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
66 - running get flanks with Region: Around start, Offset: -200, Flank-length: 300 and Location: Upstream will return **(Red: Dataset positive strand; Blue: Flanks output)**::
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
67
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
68 chr22 500 800 NM_174568 0 +
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
69
2
4b14d0e3a837 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
70 .. image:: flanks_ex1.gif
0
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
71
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
72 **Example 2**
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
73
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
74 - For the following dataset::
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
75
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
76 chr22 1000 7000 NM_028946 0 -
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
77
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
78 - running get flanks with Region: Whole, Offset: 200, Flank-length: 300 and Location: Downstream will return **(Orange: Dataset negative strand; Magenta: Flanks output)**::
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
79
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
80 chr22 500 800 NM_028946 0 -
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
81
2
4b14d0e3a837 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
82 .. image:: flanks_ex2.gif
4
077f404ae1bb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/get_flanks commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
83 ]]></help>
0
a72f0decd7b3 Imported from capsule None
devteam
parents:
diff changeset
84 </tool>