|
0
|
1 <tool id="unixtools_sed_tool" name="Text transformation" version="0.1.1">
|
|
|
2 <description>with sed</description>
|
|
|
3 <requirements>
|
|
|
4 <requirement type="package" version="4.2.2-sandbox">gnu_sed</requirement>
|
|
|
5 </requirements>
|
|
1
|
6 <command>
|
|
|
7 sed --sandbox -r
|
|
|
8
|
|
|
9 #if $adv_opts.adv_opts_selector == 'advanced':
|
|
|
10 $adv_opts.silent
|
|
|
11 #end if
|
|
|
12 -f '$sed_script' '$input' > '$output'
|
|
|
13 </command>
|
|
|
14 <inputs>
|
|
|
15 <param format="txt" name="input" type="data" label="File to process" />
|
|
0
|
16
|
|
1
|
17 <param name="url_paste" type="text" area="true" size="5x35" label="SED Program" help="">
|
|
|
18 <sanitizer>
|
|
|
19 <valid initial="string.printable">
|
|
|
20 <remove value="'"/>
|
|
|
21 </valid>
|
|
|
22 </sanitizer>
|
|
|
23 </param>
|
|
0
|
24
|
|
1
|
25 <conditional name="adv_opts">
|
|
|
26 <param name="adv_opts_selector" type="select" label="Advanced Options">
|
|
|
27 <option value="basic" selected="True">Hide Advanced Options</option>
|
|
|
28 <option value="advanced">Show Advanced Options</option>
|
|
|
29 </param>
|
|
|
30 <when value="basic" />
|
|
|
31 <when value="advanced">
|
|
|
32 <param name="silent" type="select" label="operation mode" help="(Same as 'sed -n', leave at 'normal' unless you know what you're doing)" >
|
|
|
33 <option value="">normal</option>
|
|
|
34 <option value="-n">silent</option>
|
|
|
35 </param>
|
|
|
36 </when>
|
|
|
37 </conditional>
|
|
0
|
38
|
|
|
39 </inputs>
|
|
|
40 <configfiles>
|
|
|
41 <configfile name="sed_script">
|
|
|
42 $url_paste
|
|
|
43 </configfile>
|
|
|
44 </configfiles>
|
|
|
45 <tests>
|
|
|
46 <test>
|
|
|
47 <param name="input" value="unix_sed_input1.txt" />
|
|
|
48 <output name="output" file="unix_sed_output1.txt" />
|
|
|
49 <param name="url_paste" value="1d ; s/foo/bar/" />
|
|
|
50 <param name="silent" value="" />
|
|
|
51 </test>
|
|
|
52 <test>
|
|
|
53 <param name="input" value="unix_sed_input1.txt" />
|
|
|
54 <output name="output" file="unix_sed_output2.txt" />
|
|
|
55 <param name="url_paste" value="/foo/ { s/foo/baz/g ; p }" />
|
|
|
56 <param name="silent" value="silent" />
|
|
|
57 </test>
|
|
|
58 </tests>
|
|
|
59 <outputs>
|
|
|
60 <data format="input" name="output" metadata_source="input" />
|
|
|
61 </outputs>
|
|
|
62 <help>
|
|
|
63
|
|
|
64 **What it does**
|
|
|
65
|
|
|
66 This tool runs the unix **sed** command on the selected data file.
|
|
|
67
|
|
|
68 .. class:: infomark
|
|
|
69
|
|
|
70 **TIP:** This tool uses the **extended regular** expression syntax (same as running 'sed -r').
|
|
|
71
|
|
|
72
|
|
|
73
|
|
|
74 **Further reading**
|
|
|
75
|
|
|
76 - Short sed tutorial (http://www.linuxhowtos.org/System/sed_tutorial.htm)
|
|
|
77 - Long sed tutorial (http://www.grymoire.com/Unix/Sed.html)
|
|
|
78 - sed faq with good examples (http://sed.sourceforge.net/sedfaq.html)
|
|
|
79 - sed cheat-sheet (http://www.catonmat.net/download/sed.stream.editor.cheat.sheet.pdf)
|
|
|
80 - Collection of useful sed one-liners (http://student.northpark.edu/pemente/sed/sed1line.txt)
|
|
|
81
|
|
|
82 -----
|
|
|
83
|
|
|
84 **Sed commands**
|
|
|
85
|
|
|
86 The most useful sed command is **s** (substitute).
|
|
|
87
|
|
|
88 **Examples**
|
|
|
89
|
|
|
90 - **s/hsa//** will remove the first instance of 'hsa' in every line.
|
|
|
91 - **s/hsa//g** will remove all instances (beacuse of the **g**) of 'hsa' in every line.
|
|
|
92 - **s/A{4,}/--&--/g** will find sequences of 4 or more consecutive A's, and once found, will surround them with two dashes from each side. The **&** marker is a place holder for 'whatever matched the regular expression'.
|
|
|
93 - **s/hsa-mir-([^ ]+)/short name: \\1 full name: &/** will find strings such as 'hsa-mir-43a' (the regular expression is 'hsa-mir-' followed by non-space characters) and will replace it will string such as 'short name: 43a full name: hsa-mir-43a'. The **\\1** marker is a place holder for 'whatever matched the first parenthesis' (similar to perl's **$1**) .
|
|
|
94
|
|
|
95
|
|
|
96 **sed's Regular Expression Syntax**
|
|
|
97
|
|
|
98 The select tool searches the data for lines containing or not containing a match to the given pattern. A Regular Expression is a pattern descibing a certain amount of text.
|
|
|
99
|
|
|
100 - **( ) { } [ ] . * ? + \ ^ $** are all special characters. **\\** can be used to "escape" a special character, allowing that special character to be searched for.
|
|
|
101 - **^** matches the beginning of a string(but not an internal line).
|
|
|
102 - **(** .. **)** groups a particular pattern.
|
|
|
103 - **{** n or n, or n,m **}** specifies an expected number of repetitions of the preceding pattern.
|
|
|
104
|
|
|
105 - **{n}** The preceding item is matched exactly n times.
|
|
|
106 - **{n,}** The preceding item ismatched n or more times.
|
|
|
107 - **{n,m}** The preceding item is matched at least n times but not more than m times.
|
|
|
108
|
|
|
109 - **[** ... **]** creates a character class. Within the brackets, single characters can be placed. A dash (-) may be used to indicate a range such as **a-z**.
|
|
|
110 - **.** Matches any single character except a newline.
|
|
|
111 - ***** The preceding item will be matched zero or more times.
|
|
|
112 - **?** The preceding item is optional and matched at most once.
|
|
|
113 - **+** The preceding item will be matched one or more times.
|
|
|
114 - **^** has two meaning:
|
|
|
115 - matches the beginning of a line or string.
|
|
|
116 - indicates negation in a character class. For example, [^...] matches every character except the ones inside brackets.
|
|
|
117 - **$** matches the end of a line or string.
|
|
|
118 - **\|** Separates alternate possibilities.
|
|
|
119
|
|
|
120
|
|
|
121 **Note**: SED uses extended regular expression syntax, not Perl syntax. **\\d**, **\\w**, **\\s** etc. are **not** supported.
|
|
|
122
|
|
|
123 </help>
|
|
|
124 </tool>
|
