annotate multijoin.xml @ 17:f46f0e4f75c4 draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 5f5d5802a961a77ceb092cbdef90d93e29717029-dirty"
author bgruening
date Tue, 22 Jun 2021 16:06:48 +0000
parents 4c752559b236
children 12615d397df7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
01ca80da2266 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 4379e712f76f2bb12ee2cc270dd8a0e806df2cd6
bgruening
parents: 6
diff changeset
1 <tool id="tp_multijoin_tool" name="Multi-Join" version="@BASE_VERSION@.1">
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
2 <description>(combine multiple files)</description>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
3 <macros>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
4 <import>macros.xml</import>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
5 </macros>
5
20344ce0c811 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents: 3
diff changeset
6 <requirements>
7
01ca80da2266 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 4379e712f76f2bb12ee2cc270dd8a0e806df2cd6
bgruening
parents: 6
diff changeset
7 <requirement type="package" version="5.22.0.1">perl</requirement>
5
20344ce0c811 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents: 3
diff changeset
8 </requirements>
20344ce0c811 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents: 3
diff changeset
9 <command>
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
10 <![CDATA[
5
20344ce0c811 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents: 3
diff changeset
11 perl '$__tool_directory__/multijoin'
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
12 --key '$key_column'
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
13 --values '$value_columns'
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
14 --filler '$filler'
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
15 $ignore_dups
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
16 $output_header
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
17 $input_header
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
18 $first_file
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
19 #for $file in $files:
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
20 '$file'
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
21 #end for
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
22 > '$outfile'
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
23 ]]>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
24 </command>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
25 <inputs>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
26 <param name="first_file" type="data" format="txt" label="File to join"/>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
27 <param name="files" multiple="True" type="data" format="txt" label="add additional file" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
28
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
29 <param name="key_column" label="Common key column" type="integer"
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
30 value="1" help="Usually gene-ID or other common value" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
31
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
32 <param name="value_columns" label="Column with values to preserve"
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
33 type="data_column" data_ref="first_file" accept_default="true" multiple="True" display="checkboxes"/>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
34
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
35 <param name="output_header" type="boolean" checked="false" truevalue="--out-header" falsevalue="" label="Add header line to the output file" help="" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
36 <param name="input_header" type="boolean" checked="false" truevalue="--in-header" falsevalue="" label="Input files contain a header line (as first line)" help="" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
37 <param name="ignore_dups" type="boolean" checked="false" truevalue="--ignore-dups" falsevalue="" label="Ignore duplicated keys" help="If not set, duplicated keys in the same file will cause an error." />
3
37e1eb05b1b4 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 10052765d6b712cf7d38356af4251fcc38a339b6-dirty
bgruening
parents: 0
diff changeset
38 <param name="filler" type="text" value="0" label="Value to put in unpaired (empty) fields">
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
39 <sanitizer>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
40 <valid initial="string.printable">
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
41 <remove value="&apos;"/>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
42 </valid>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
43 </sanitizer>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
44 </param>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
45 </inputs>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
46 <outputs>
8
4c752559b236 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 3103ebed1a420c7d3415b67ef532ea579edf9faa
bgruening
parents: 7
diff changeset
47 <data name="outfile" format="tabular" />
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
48 </outputs>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
49 <tests>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
50 <test>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
51 <param name="first_file" value="multijoin1.txt" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
52 <param name="files" value="multijoin2.txt,multijoin3.txt" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
53 <param name="key_column" value="4" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
54 <param name="value_columns" value="c7,c8,c9" />
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
55 <param name="output_header" value="True" />
5
20344ce0c811 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents: 3
diff changeset
56 <output name="outfile" file="multijoin_result1.txt" lines_diff="2" />
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
57 </test>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
58 </tests>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
59 <help>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
60 <![CDATA[
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
61 **What it does**
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
62
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
63 This tool joins multiple tabular files based on a common key column.
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
64
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
65 -----
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
66
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
67 **Example**
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
68
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
69 To join three files, based on the 4th column, and keeping the 7th,8th,9th columns:
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
70
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
71 **First file (AAA)**::
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
72
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
73 chr4 888449 890171 FBtr0308778 0 + 266 1527 1722
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
74 chr4 972167 979017 FBtr0310651 0 - 3944 6428 6850
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
75 chr4 972186 979017 FBtr0089229 0 - 3944 6428 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
76 chr4 972186 979017 FBtr0089231 0 - 3944 6428 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
77 chr4 972186 979017 FBtr0089233 0 - 3944 6428 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
78 chr4 995793 996435 FBtr0111046 0 + 7 166 642
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
79 chr4 995793 997931 FBtr0111044 0 + 28 683 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
80 chr4 995793 997931 FBtr0111045 0 + 28 683 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
81 chr4 1034029 1047719 FBtr0089223 0 - 5293 13394 13690
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
82 ...
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
83
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
84
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
85 **Second File (BBB)**::
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
86
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
87 chr4 90286 134453 FBtr0309803 0 + 657 29084 44167
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
88 chr4 251355 266499 FBtr0089116 0 + 56 1296 15144
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
89 chr4 252050 266506 FBtr0308086 0 + 56 1296 14456
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
90 chr4 252050 266506 FBtr0308087 0 + 56 1296 14456
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
91 chr4 252053 266528 FBtr0300796 0 + 56 1296 14475
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
92 chr4 252053 266528 FBtr0300800 0 + 56 1296 14475
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
93 chr4 252055 266528 FBtr0300798 0 + 56 1296 14473
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
94 chr4 252055 266528 FBtr0300799 0 + 56 1296 14473
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
95 chr4 252541 266528 FBtr0300797 0 + 56 1296 13987
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
96 ...
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
97
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
98 **Third file (CCC)**::
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
99
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
100 chr4 972167 979017 FBtr0310651 0 - 9927 6738 6850
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
101 chr4 972186 979017 FBtr0089229 0 - 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
102 chr4 972186 979017 FBtr0089231 0 - 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
103 chr4 972186 979017 FBtr0089233 0 - 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
104 chr4 995793 996435 FBtr0111046 0 + 5 304 642
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
105 chr4 995793 997931 FBtr0111044 0 + 17 714 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
106 chr4 995793 997931 FBtr0111045 0 + 17 714 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
107 chr4 1034029 1047719 FBtr0089223 0 - 17646 13536 13690
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
108 ...
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
109
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
110
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
111 **Joining** the files, using **key column 4**, **value columns 7,8,9** and a **header line**, will return::
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
112
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
113 key AAA__V7 AAA__V8 AAA__V9 BBB__V7 BBB__V8 BBB__V9 CCC__V7 CCC__V8 CCC__V9
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
114 FBtr0089116 0 0 0 56 1296 15144 0 0 0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
115 FBtr0089223 5293 13394 13690 0 0 0 17646 13536 13690
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
116 FBtr0089229 3944 6428 6831 0 0 0 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
117 FBtr0089231 3944 6428 6831 0 0 0 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
118 FBtr0089233 3944 6428 6831 0 0 0 9927 6738 6831
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
119 FBtr0111044 28 683 2138 0 0 0 17 714 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
120 FBtr0111045 28 683 2138 0 0 0 17 714 2138
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
121 FBtr0111046 7 166 642 0 0 0 5 304 642
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
122 FBtr0300796 0 0 0 56 1296 14475 0 0 0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
123 ...
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
124
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
125 .. class:: infomark
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
126
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
127 Input files need not be sorted.
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
128
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
129 @REFERENCES@
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
130 ]]>
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
131 </help>
6
60edf2f8c28f planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b'e6ee273f75fff61d1e419283fa8088528cf59470\n'
bgruening
parents: 5
diff changeset
132 <expand macro="citations" />
0
5314e5d6f040 Imported from capsule None
bgruening
parents:
diff changeset
133 </tool>