annotate easyjoin.xml @ 9:d9819ccb9ca7 draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 369e40078146d00608d52205bb8cee66ae735b76-dirty
author bgruening
date Tue, 30 Jun 2015 17:47:36 -0400
parents fa7f88da29d7
children c78b1767db2b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
1 <tool id="tp_easyjoin_tool" name="Join" version="@BASE_VERSION@.0">
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
2 <description>two files</description>
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
3 <macros>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
4 <import>macros.xml</import>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
5 </macros>
8
fa7f88da29d7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 369e40078146d00608d52205bb8cee66ae735b76-dirty
bgruening
parents: 6
diff changeset
6 <expand macro="requirements" />
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
7 <version_command>join --version | head -n 1</version_command>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
8 <command>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
9 <![CDATA[
8
fa7f88da29d7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 369e40078146d00608d52205bb8cee66ae735b76-dirty
bgruening
parents: 6
diff changeset
10 cp $__tool_directory__/sort-header ./ &&
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
11 chmod +x sort-header &&
8
fa7f88da29d7 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 369e40078146d00608d52205bb8cee66ae735b76-dirty
bgruening
parents: 6
diff changeset
12 perl $__tool_directory__/easyjoin
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
13 $jointype
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
14 -t ' '
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
15 $header
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
16 -e '$empty_string_filler'
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
17 -o auto
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
18 $ignore_case
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
19 -1 '$column1'
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
20 -2 '$column2'
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
21 "$infile1"
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
22 "$infile2"
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
23 > '$output'
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
24 ]]>
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
25 </command>
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
26 <inputs>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
27 <param name="infile1" format="tabular" type="data" label="1st file" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
28 <param name="column1" label="Column to use from 1st file" type="data_column" data_ref="infile1" accept_default="true" />
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
29
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
30 <param name="infile2" format="txt" type="data" label="2nd File" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
31 <param name="column2" label="Column to use from 2nd file" type="data_column" data_ref="infile2" accept_default="true" />
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
32
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
33 <param name="jointype" type="select" label="Output lines appearing in">
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
34 <option value=" " selected="True">Both 1st &amp; 2nd file.</option>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
35 <option value="-v 1">1st but not in 2nd file. (-v 1)</option>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
36 <option value="-v 2">2nd but not in 1st file. (-v 2)</option>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
37 <option value="-a 1">Both 1st &amp; 2nd file, plus unpairable lines from 1st file. (-a 1)</option>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
38 <option value="-a 2">Both 1st &amp; 2nd file, plus unpairable lines from 2st file. (-a 2)</option>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
39 <option value="-a 1 -a 2">All lines [-a 1 -a 2]</option>
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
40 <option value="-v 1 -v 2">All unpairable lines [-v 1 -v 2]</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
41 </param>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
42
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
43 <param name="header" type="boolean" checked="false" truevalue="--header" falsevalue=""
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
44 label="First line is a header line" help="Use if first line contains column headers. It will not be sorted." />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
45 <param name="ignore_case" type="boolean" checked="false" truevalue="-i" falsevalue=""
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
46 label="Ignore case" help="Sort and Join key column values regardless of upper/lower case letters." />
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
47 <param name="empty_string_filler" type="text" size="20" value="0" label="Value to put in unpaired (empty) fields">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
48 <sanitizer>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
49 <valid initial="string.printable">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
50 <remove value="&apos;"/>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
51 </valid>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
52 </sanitizer>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
53 </param>
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
54 </inputs>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
55 <outputs>
6
8928e6d1e7ba Uploaded
bgruening
parents: 4
diff changeset
56 <data name="output" format_source="infile1" metadata_source="infile1"/>
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
57 </outputs>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
58 <tests>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
59 <test>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
60 <param name="infile1" value="easyjoin1.tabular" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
61 <param name="column1" value="1" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
62 <param name="infile2" value="easyjoin2.tabular" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
63 <param name="column2" value="1" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
64 <param name="header" value="True" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
65 <param name="jointype" value="-a 1 -a 2" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
66 <output name="output" file="easyjoin_result1.tabular" />
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
67 </test>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
68 </tests>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
69 <help>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
70 <![CDATA[
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
71 **What it does**
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
72
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
73 This tool joins two tabular files based on a common key column.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
74
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
75 -----
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
76
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
77 **Example**
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
78
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
79 **First file**::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
80
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
81 Fruit Color
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
82 Apple red
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
83 Banana yellow
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
84 Orange orange
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
85 Melon green
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
86
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
87 **Second File**::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
88
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
89 Fruit Price
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
90 Orange 7
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
91 Avocado 8
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
92 Apple 4
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
93 Banana 3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
94
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
95 **Joining** both files, using **key column 1** and a **header line**, will return::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
96
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
97 Fruit Color Price
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
98 Apple red 4
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
99 Avocado . 8
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
100 Banana yellow 3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
101 Melon green .
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
102 Orange orange 7
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
103
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
104 .. class:: infomark
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
105
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
106 * Input files need not be sorted.
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
107 * The header line (**Fruit Color Price**) was joined and kept as first line.
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
108 * Missing values ( Avocado's color, missing from the first file ) are replaced with a period character.
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
109
4
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
110 @REFERENCES@
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
111 ]]>
56e80527c482 Uploaded
bgruening
parents: 3
diff changeset
112 </help>
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
113 </tool>