annotate cut.xml @ 0:ec66f9d90ef0 draft

initial uploaded
author bgruening
date Thu, 05 Sep 2013 04:58:21 -0400
parents
children a4ad586d1403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
1 <tool id="unixtools_cut_tool" name="cut" version="0.1.1">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
2 <description>columns from files</description>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
3 <requirements>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
4 <requirement type="package" version="8.21">gnu_coreutils</requirement>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
5 </requirements>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
6 <command>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
7 cut ${complement} ${cutwhat} '${list}' '${input}' &gt; '${output}'
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
8 </command>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
9
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
10 <inputs>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
11 <param format="txt" name="input" type="data" label="file to cut" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
12 <param name="complement" type="select" label="Operation">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
13 <option value="">Keep</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
14 <option value="--complement">Discard</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
15 </param>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
16
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
17 <param name="cutwhat" type="select" label="Cut by">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
18 <option value="-f">fields</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
19 <option value="-c">characters</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
20 <option value="-b">bytes</option>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
21 </param>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
22
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
23 <param name="list" type="text" size="20" value="" label="List of Fields/Characters/Bytes" help="These will be kept/discarded (depending on 'operation'). &lt;BR /&gt; Examples: 1,3,4 or 2-5">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
24 <sanitizer>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
25 <valid initial="string.printable">
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
26 <remove value="&apos;"/>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
27 </valid>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
28 </sanitizer>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
29 </param>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
30 </inputs>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
31
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
32 <tests>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
33 <test>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
34 <param name="input" value="unix_cut_input1.txt" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
35 <output name="output" file="unix_cut_output1.txt" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
36 <param name="complement" value="Keep" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
37 <param name="cutwhat" value="fields" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
38 <param name="list" value="1,3,4" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
39 </test>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
40 <test>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
41 <param name="input" value="unix_cut_input1.txt" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
42 <output name="output" file="unix_cut_output1.txt" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
43 <param name="complement" value="Discard" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
44 <param name="cutwhat" value="fields" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
45 <param name="list" value="2" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
46 </test>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
47 </tests>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
48
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
49 <outputs>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
50 <data format="input" name="output" metadata_source="input" />
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
51 </outputs>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
52 <help>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
53
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
54 **What it does**
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
55
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
56 This tool runs the **cut** unix command, which extract or delete columns from a file.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
57
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
58 -----
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
59
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
60 Field List Example:
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
61
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
62 **1,3,7** - Cut specific fields/characters.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
63
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
64 **3-** - Cut from the third field/character to the end of the line.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
65
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
66 **2-5** - Cut from the second to the fifth field/character.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
67
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
68 **-8** - Cut from the first to the eight field/characters.
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
69
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
70
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
71
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
72
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
73 Input Example::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
74
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
75 fruit color price weight
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
76 apple red 1.4 0.5
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
77 orange orange 1.5 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
78 banana yellow 0.9 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
79
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
80
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
81 Output Example ( **Keeping fields 1,3,4** )::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
82
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
83 fruit price weight
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
84 apple 1.4 0.5
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
85 orange 1.5 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
86 banana 0.9 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
87
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
88 Output Example ( **Discarding field 2** )::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
89
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
90 fruit price weight
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
91 apple 1.4 0.5
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
92 orange 1.5 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
93 banana 0.9 0.3
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
94
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
95 Output Example ( **Keeping 3 characters** )::
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
96
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
97 fru
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
98 app
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
99 ora
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
100 ban
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
101
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
102 </help>
ec66f9d90ef0 initial uploaded
bgruening
parents:
diff changeset
103 </tool>