upstream-extended/community/tools/text_processing/text_processing/cut.xml
1<tool id="tp_cut_tool" name="Advanced Cut" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2 <description>columns from a table (cut)</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements" />
7 <version_command>cut --version | head -n 1</version_command>
8 <command>
9<![CDATA[
10 cut
11 $complement
12 $cut_type_options.cut_element
13 #if $cut_type_options.cut_element != '-f'
14 '$cut_type_options.list'
15 #else
16 '$cut_type_options.colnames_option.list'
17 #if str($cut_type_options.delimiter) != '':
18 -d"$cut_type_options.delimiter"
19 #end if
20 #end if
21 '$input'
22 > '$output'
23]]>
24 </command>
25 <inputs>
26 <param name="input" format="txt" type="data" label="File to cut" />
27 <param name="complement" type="select" label="Operation">
28 <option value="">Keep</option>
29 <option value="--complement">Discard</option>
30 </param>
31 <conditional name="cut_type_options">
32 <param name="cut_element" type="select" label="Cut by">
33 <option value="-f">fields</option>
34 <option value="-c">characters</option>
35 </param>
36 <when value="-f">
37 <param name="delimiter" type="select" label="Delimited by">
38 <option value="">Tab</option>
39 <option value=" ">Whitespace</option>
40 <option value=".">Dot</option>
41 <option value=",">Comma</option>
42 <option value="-">Dash</option>
43 <option value="_">Underscore</option>
44 <option value="|">Pipe</option>
45 </param>
46 <conditional name="colnames_option">
47 <param name="header" type="select" label="Is there a header for the data's columns ?" refresh_on_change="true">
48 <option value="Y">Yes</option>
49 <option value="N" selected="true">No</option>
50 </param>
51 <when value="Y">
52 <param name="list" type="data_column" data_ref="input" use_header_names="true" multiple="true" label="List of Fields" help="(-f)" />
53 </when>
54 <when value="N">
55 <param name="list" type="data_column" data_ref="input" multiple="true" label="List of Fields" help="(-f)" />
56 </when>
57 </conditional>
58 </when>
59 <when value="-c">
60 <param name="list" type="text" value="" label="List of characters" help="These will be kept/discarded (depending on 'operation'). <BR /> Examples: 1,3,4 or 2-5">
61 <sanitizer>
62 <valid initial="string.printable">
63 <remove value="'"/>
64 </valid>
65 </sanitizer>
66 </param>
67 </when>
68 </conditional>
69 </inputs>
70 <outputs>
71 <!--<data format="tabular" name="output" />-->
72 <!-- WIP, not sure that will work with the complement option -->
73 <data format="tabular" name="output">
74 <actions>
75 <conditional name="cut_type_options.cut_element">
76 <!-- fields -->
77 <when value="-f">
78 <conditional name="cut_type_options.delimiter">
79 <when value="T">
80 <conditional name="input">
81 <when datatype_isinstance="interval">
82 <action type="format" default="tabular">
83 <option type="from_param" name="list" column="0" offset="0"> <!-- chromCol is 1-->
84 <filter type="insert_column" column="0" value="interval"/>
85 <filter type="insert_column" ref="list" /> <!-- startCol -->
86 <filter type="insert_column" ref="list" /> <!-- endCol -->
87
88 <filter type="multiple_splitter" column="1" separator=","/>
89 <filter type="column_strip" column="1"/> <!-- get rid of all external whitespace -->
90 <filter type="string_function" column="1" name="lower" />
91 <filter type="param_value" column="1" value="^c\d{1,}$" compare="re_search" keep="True"/>
92 <filter type="column_strip" column="1" strip="c"/> <!-- get rid of c's -->
93 <filter type="boolean" column="1" cast="int" />
94
95 <filter type="multiple_splitter" column="2" separator=","/>
96 <filter type="column_strip" column="2"/> <!-- get rid of all external whitespace -->
97 <filter type="string_function" column="2" name="lower" />
98 <filter type="param_value" column="2" value="^c\d{1,}$" compare="re_search" keep="True"/>
99 <filter type="column_strip" column="2" strip="c"/> <!-- get rid of c's -->
100 <filter type="boolean" column="2" cast="int" />
101
102 <filter type="multiple_splitter" column="3" separator=","/>
103 <filter type="column_strip" column="3"/> <!-- get rid of all external whitespace -->
104 <filter type="string_function" column="3" name="lower" />
105 <filter type="param_value" column="3" value="^c\d{1,}$" compare="re_search" keep="True"/>
106 <filter type="column_strip" column="3" strip="c"/> <!-- get rid of c's -->
107 <filter type="boolean" column="3" cast="int" />
108
109 <filter type="metadata_value" ref="input" name="chromCol" column="1" />
110 <filter type="metadata_value" ref="input" name="startCol" column="2" />
111 <filter type="metadata_value" ref="input" name="endCol" column="3" />
112 </option>
113 </action>
114 </when>
115 </conditional>
116 </when>
117 </conditional>
118 <conditional name="output">
119 <when datatype_isinstance="interval">
120 <action type="metadata" name="chromCol">
121 <option type="from_param" name="list" column="0" offset="0"> <!-- chromCol is 0-->
122 <filter type="multiple_splitter" column="0" separator=","/>
123 <filter type="column_strip" column="0"/> <!-- get rid of all external whitespace -->
124 <filter type="string_function" column="0" name="lower" />
125 <filter type="param_value" column="0" value="^c\d{1,}$" compare="re_search" keep="True"/>
126 <filter type="column_strip" column="0" strip="c"/> <!-- get rid of c's -->
127 <filter type="insert_column" value="1" iterate="True" column="0"/>
128 <filter type="boolean" column="1" cast="int" />
129 <filter type="metadata_value" ref="input" name="chromCol" column="1" />
130 </option>
131 </action>
132
133 <action type="metadata" name="startCol">
134 <option type="from_param" name="list" column="0" offset="0"> <!-- startCol is 0-->
135 <filter type="multiple_splitter" column="0" separator=","/>
136 <filter type="column_strip" column="0"/> <!-- get rid of all external whitespace -->
137 <filter type="string_function" column="0" name="lower" />
138 <filter type="param_value" column="0" value="^c\d{1,}$" compare="re_search" keep="True"/>
139 <filter type="column_strip" column="0" strip="c"/> <!-- get rid of c's -->
140 <filter type="insert_column" value="1" iterate="True" column="0"/>
141 <filter type="boolean" column="1" cast="int" />
142 <filter type="metadata_value" ref="input" name="startCol" column="1" />
143 </option>
144 </action>
145
146 <action type="metadata" name="endCol">
147 <option type="from_param" name="list" column="0" offset="0"> <!-- endCol is 0-->
148 <filter type="multiple_splitter" column="0" separator=","/>
149 <filter type="column_strip" column="0"/> <!-- get rid of all external whitespace -->
150 <filter type="string_function" column="0" name="lower" />
151 <filter type="param_value" column="0" value="^c\d{1,}$" compare="re_search" keep="True"/>
152 <filter type="column_strip" column="0" strip="c"/> <!-- get rid of c's -->
153 <filter type="insert_column" value="1" iterate="True" column="0"/>
154 <filter type="boolean" column="1" cast="int" />
155 <filter type="metadata_value" ref="input" name="endCol" column="1" />
156 </option>
157 </action>
158
159 <action type="metadata" name="nameCol" default="0">
160 <option type="from_param" name="list" column="0" offset="0"> <!-- nameCol is 0-->
161 <filter type="multiple_splitter" column="0" separator=","/>
162 <filter type="column_strip" column="0"/> <!-- get rid of all external whitespace -->
163 <filter type="string_function" column="0" name="lower" />
164 <filter type="param_value" column="0" value="^c\d{1,}$" compare="re_search" keep="True"/>
165 <filter type="column_strip" column="0" strip="c"/> <!-- get rid of c's -->
166 <filter type="insert_column" value="1" iterate="True" column="0"/>
167 <filter type="boolean" column="1" cast="int" />
168 <filter type="metadata_value" ref="input" name="nameCol" column="1" />
169 </option>
170 </action>
171
172 <action type="metadata" name="strandCol" default="0">
173 <option type="from_param" name="list" column="0" offset="0"> <!-- strandCol is 0-->
174 <filter type="multiple_splitter" column="0" separator=","/>
175 <filter type="column_strip" column="0"/> <!-- get rid of all external whitespace -->
176 <filter type="string_function" column="0" name="lower" />
177 <filter type="param_value" column="0" value="^c\d{1,}$" compare="re_search" keep="True"/>
178 <filter type="column_strip" column="0" strip="c"/> <!-- get rid of c's -->
179 <filter type="insert_column" value="1" iterate="True" column="0"/>
180 <filter type="boolean" column="1" cast="int" />
181 <filter type="metadata_value" ref="input" name="strandCol" column="1" />
182 </option>
183 </action>
184 </when>
185 </conditional>
186 </when>
187 </conditional>
188 </actions>
189 </data>
190 </outputs>
191 <tests>
192 <test expect_num_outputs="1">
193 <param name="input" value="cut1.txt"/>
194 <conditional name="cut_type_options">
195 <param name="cut_element" value="-f"/>
196 <param name="delimiter" value="" />
197 <conditional name="colnames_option">
198 <param name="header" value="Y"/>
199 <param name="list" value="1,3,4"/>
200 </conditional>
201 </conditional>
202 <output name="output" file="cut_results1.txt"/>
203 <assert_command>
204 <has_text text="-f '1,3,4'"/>
205 </assert_command>
206 </test>
207 <test expect_num_outputs="1">
208 <param name="input" value="cut1.txt"/>
209 <conditional name="cut_type_options">
210 <param name="delimiter" value="" />
211 <conditional name="colnames_option">
212 <param name="header" value="Y"/>
213 <!-- in the test we can (apparently) not select by header name -->
214 <param name="list" value="2" />
215 </conditional>
216 </conditional>
217 <param name="complement" value="--complement" />
218 <output name="output" file="cut_results2.txt"/>
219 <assert_command>
220 <has_text text="-f '2'"/>
221 </assert_command>
222 </test>
223 <test expect_num_outputs="1">
224 <param name="input" value="cut1.txt"/>
225 <conditional name="cut_type_options">
226 <param name="cut_element" value="-c" />
227 <param name="list" value="-3" />
228 </conditional>
229 <output name="output" file="cut_results3.txt"/>
230 </test>
231 </tests>
232 <help>
233<![CDATA[
234**What it does**
235
236This tool runs the **cut** unix command, which extract or delete columns from a file.
237
238-----
239
240Field List Example:
241
242**1,3,7** - Cut specific fields/characters.
243
244**3-** - Cut from the third field/character to the end of the line.
245
246**2-5** - Cut from the second to the fifth field/character.
247
248**-8** - Cut from the first to the eight field/characters.
249
250
251Input Example::
252
253 fruit color price weight
254 apple red 1.4 0.5
255 orange orange 1.5 0.3
256 banana yellow 0.9 0.3
257
258
259Output Example ( **Keeping fields 1,3,4** )::
260
261 fruit price weight
262 apple 1.4 0.5
263 orange 1.5 0.3
264 banana 0.9 0.3
265
266Output Example ( **Discarding field 2** )::
267
268 fruit price weight
269 apple 1.4 0.5
270 orange 1.5 0.3
271 banana 0.9 0.3
272
273Output Example ( **Keeping 3 characters** )::
274
275 fru
276 app
277 ora
278 ban
279
280@REFERENCES@
281]]>
282 </help>
283 <expand macro="citations" />
284</tool>