annotate easyjoin.xml @ 0:631dfde45073 draft default tip

First tool-shed public version
author gordon
date Tue, 09 Oct 2012 18:48:06 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
1 <tool id="cshl_easyjoin" name="Join" version="0.1.1">
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
2 <description>two files</description>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
3 <command interpreter="perl">easyjoin $jointype
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
4 -t ' '
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
5 $header
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
6 -e '$empty_string_filler'
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
7 -o auto
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
8 $ignore_case
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
9 -1 "$column1"
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
10 -2 "$column2"
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
11 "$input1" "$input2"
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
12 &gt; '$output'
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
13 </command>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
14
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
15 <inputs>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
16 <param format="txt" name="input1" type="data" label="1st file" />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
17 <param name="column1" label="Column to use from 1st file" type="data_column" data_ref="input1" accept_default="true" />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
18
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
19 <param format="txt" name="input2" type="data" label="2nd File" />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
20 <param name="column2" label="Column to use from 2nd file" type="data_column" data_ref="input2" accept_default="true" />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
21
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
22 <param name="jointype" type="select" label="Output lines appearing in">
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
23 <option value=" ">BOTH 1st &amp; 2nd file.</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
24 <option value="-v 1">1st but not in 2nd file. [-v 1]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
25 <option value="-v 2">2nd but not in 1st file. [-v 2]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
26 <option value="-a 1">both 1st &amp; 2nd file, plus unpairable lines from 1st file. [-a 1]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
27 <option value="-a 2">both 1st &amp; 2nd file, plus unpairable lines from 2st file. [-a 2]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
28 <option value="-a 1 -a 2">All Lines [-a 1 -a 2]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
29 <option value="-v 1 -v 2">All unpairable lines [-v 1 -v 2]</option>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
30 </param>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
31
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
32 <param name="header" type="boolean" checked="false" truevalue="--header" falsevalue="" label="First line is a header line" help="Use if first line contains column headers. It will not be sorted." />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
33
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
34 <param name="ignore_case" type="boolean" checked="false" truevalue="-i" falsevalue="" label="Ignore case" help="Sort and Join key column values regardless of upper/lower case letters." />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
35
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
36 <param name="empty_string_filler" type="text" size="20" value="0" label="Value to put in unpaired (empty) fields">
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
37 <sanitizer>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
38 <valid initial="string.printable">
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
39 <remove value="&apos;"/>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
40 </valid>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
41 </sanitizer>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
42 </param>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
43
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
44 </inputs>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
45 <outputs>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
46 <data name="output" format="input" metadata_source="input1"
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
47 />
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
48 </outputs>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
49
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
50 <help>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
51 **What it does**
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
52
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
53 This tool joins two tabular files based on a common key column.
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
54
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
55 -----
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
56
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
57 **Example**
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
58
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
59 **First file**::
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
60
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
61 Fruit Color
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
62 Apple red
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
63 Banana yellow
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
64 Orange orange
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
65 Melon green
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
66
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
67 **Second File**::
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
68
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
69 Fruit Price
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
70 Orange 7
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
71 Avocado 8
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
72 Apple 4
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
73 Banana 3
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
74
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
75 **Joining** both files, using **key column 1** and a **header line**, will return::
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
76
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
77 Fruit Color Price
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
78 Apple red 4
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
79 Avocado . 8
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
80 Banana yellow 3
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
81 Melon green .
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
82 Orange orange 7
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
83
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
84 # Input files need not be sorted.
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
85 # The header line (**Fruit Color Price**) was joined and kept as first line.
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
86 # Missing values ( Avocado's color, missing from the first file ) are replaced with a period character.
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
87
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
88 -----
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
89
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
90 *easyjoin* was written by A. Gordon
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
91
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
92 </help>
631dfde45073 First tool-shed public version
gordon
parents:
diff changeset
93 </tool>