Source code

Download source archive ↓

upstream-extended/community/tools/text_processing/text_processing/easyjoin.xml

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