annotate complement.xml @ 4:1b2bfb9981b1 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/complement commit de7140295cce07e1bc1697e51dab4271c8d7a8a6
author devteam
date Fri, 18 Dec 2015 19:37:08 -0500
parents a3c7fd2ae338
children 1377a23bc02a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8f2c476e92ed Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="gops_complement_1" name="Complement" version="1.0.0">
0
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
2 <description>intervals of a dataset</description>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.7.1">bx-python</requirement>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
7 <command interpreter="python">gops_complement.py $input1 $output -1 ${input1.metadata.chromCol},${input1.metadata.startCol},${input1.metadata.endCol},${input1.metadata.strandCol} -l ${chromInfo} $allchroms</command>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
8 <inputs>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
9 <param format="interval" name="input1" type="data">
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
10 <label>Complement regions of</label>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
11 </param>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
12 <param name="allchroms" type="boolean" truevalue="--all" falsevalue="" label="Genome-wide complement">
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
13 </param>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
14 </inputs>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
15 <outputs>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
16 <data format="input" name="output" metadata_source="input1" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
17 </outputs>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
18 <code file="operation_filter.py"/>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
19 <tests>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
20 <test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
21 <param name="input1" value="1.bed" dbkey="hg17" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
22 <param name="allchroms" value="true" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
23 <output name="output" file="gops_complement_out.bed" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
24 </test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
25 <test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
26 <param name="input1" value="2_mod.bed" ftype="interval" dbkey="hg17" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
27 <param name="allchroms" value="true" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
28 <output name="output" file="gops_complement_out_diffCols.dat" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
29 </test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
30 <test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
31 <param name="input1" value="gops_bigint.interval" dbkey="hg17" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
32 <param name="allchroms" value="true" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
33 <output name="output" file="gops_complement_out2.bed" />
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
34 </test>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
35 </tests>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
36 <help>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
37
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
38 .. class:: infomark
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
39
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
40 **TIP:** If your dataset does not appear in the pulldown menu, it means that it is not in interval format. Use "edit attributes" to set chromosome, start, end, and strand columns.
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
41
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
42 This operation complements the regions of a set of intervals. Regions are returned that represent the empty space in the input interval.
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
43
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
44 -----
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
45
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
46 **Screencasts!**
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
47
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
48 See Galaxy Interval Operation Screencasts_ (right click to open this link in another window).
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
49
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
50 .. _Screencasts: http://wiki.g2.bx.psu.edu/Learn/Interval%20Operations
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
51
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
52 -----
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
53
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
54 **Syntax**
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
55
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
56 - **Genome-wide complement** will complement all chromosomes of the genome. Leaving this option unchecked will only complement chromosomes present in the dataset.
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
57
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
58 -----
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
59
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
60 **Example**
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
61
2
a3c7fd2ae338 Added tool image.
Dave Bouvier <dave@bx.psu.edu>
parents: 1
diff changeset
62 .. image:: gops_complement.gif
0
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
63
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
64 </help>
b4415197029e Imported from capsule None
devteam
parents:
diff changeset
65 </tool>