Mercurial > repos > bgruening > text_processing
annotate replace_text_in_line.xml @ 20:1aa30b2c73c9 draft
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 4f79443517baf378fbfe1f81be361d97f2938601
author | bgruening |
---|---|
date | Wed, 03 Apr 2019 13:56:43 -0400 |
parents | bed2226b90f7 |
children | f22a309187a3 |
rev | line source |
---|---|
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
1 <tool id="tp_replace_in_line" name="Replace Text" version="@BASE_VERSION@.2"> |
3 | 2 <description>in entire line</description> |
4 | 3 <macros> |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
4 <import>macros.xml</import> |
4 | 5 </macros> |
13
3c685c4106b3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents:
12
diff
changeset
|
6 <requirements> |
18
1e974b82380d
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 0ba37c1f33eeb1c77b4d9363d681fe522d9f7fe7
bgruening
parents:
17
diff
changeset
|
7 <requirement type="package" version="4.4">sed</requirement> |
13
3c685c4106b3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b9d202134c3c6d0e5c398c3ae75e410067fcfc52
bgruening
parents:
12
diff
changeset
|
8 </requirements> |
4 | 9 <version_command>sed --version | head -n 1</version_command> |
6 | 10 <command> |
4 | 11 <![CDATA[ |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
12 sed |
18
1e974b82380d
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 0ba37c1f33eeb1c77b4d9363d681fe522d9f7fe7
bgruening
parents:
17
diff
changeset
|
13 -r |
1e974b82380d
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 0ba37c1f33eeb1c77b4d9363d681fe522d9f7fe7
bgruening
parents:
17
diff
changeset
|
14 --sandbox |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
15 #for $replacement in $replacements: |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
16 -e |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
17 's/$replacement.find_pattern/$replacement.replace_pattern/g' |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
18 #end for |
18
1e974b82380d
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 0ba37c1f33eeb1c77b4d9363d681fe522d9f7fe7
bgruening
parents:
17
diff
changeset
|
19 '$infile' |
1e974b82380d
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 0ba37c1f33eeb1c77b4d9363d681fe522d9f7fe7
bgruening
parents:
17
diff
changeset
|
20 > '$outfile' |
4 | 21 ]]> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
22 |
3 | 23 </command> |
24 <inputs> | |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
25 <param format="txt" name="infile" type="data" label="File to process" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
26 <repeat name="replacements" title="Replacement" min="1"> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
27 <param name="find_pattern" type="text" size="20" label="Find pattern" help="Use simple text, or a valid regular expression (without backslashes // ) " > |
3 | 28 <sanitizer> |
29 <valid initial="string.printable"> | |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
30 <remove value="'"/> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
31 <remove value="/"/> |
3 | 32 </valid> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
33 <mapping initial="none"> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
34 <add source="'" target="'"'"'" /> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
35 <add source="/" target="\/"/> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
36 </mapping> |
3 | 37 </sanitizer> |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
38 </param> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
39 <param name="replace_pattern" type="text" size="20" label="Replace with:" help="Use simple text, or & (ampersand) and \\1 \\2 \\3 to refer to matched text. See examples below." > |
3 | 40 <sanitizer> |
41 <valid initial="string.printable"> | |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
42 <remove value="'"/> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
43 <remove value="/"/> |
3 | 44 </valid> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
45 <mapping initial="none"> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
46 <add source="'" target="'"'"'" /> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
47 <add source="/" target="\/"/> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
48 </mapping> |
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
49 |
3 | 50 </sanitizer> |
17
f2918761eaf3
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit f48156f03164bde1f1be4826b2f0a1f16dc2cd2f
bgruening
parents:
16
diff
changeset
|
51 |
3 | 52 </param> |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
53 </repeat> |
3 | 54 </inputs> |
55 <outputs> | |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
56 <data name="outfile" format_source="infile" metadata_source="infile"/> |
3 | 57 </outputs> |
4 | 58 <tests> |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
59 <test> |
6 | 60 <param name="infile" value="replace_text_in_line1.txt" /> |
4 | 61 <param name="find_pattern" value="CTC." /> |
62 <param name="replace_pattern" value="FOOBAR" /> | |
6 | 63 <output name="outfile" file="replace_text_in_line_results1.txt" /> |
4 | 64 </test> |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
65 <test> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
66 <param name="infile" value="replace_text_in_line1.txt" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
67 <repeat name="replacements"> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
68 <param name="find_pattern" value="CTC." /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
69 <param name="replace_pattern" value="FOOBAR" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
70 </repeat> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
71 <repeat name="replacements"> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
72 <param name="find_pattern" value="chr" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
73 <param name="replace_pattern" value="domain" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
74 </repeat> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
75 <output name="outfile" file="replace_text_in_line_results2.txt" /> |
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
76 </test> |
4 | 77 </tests> |
3 | 78 <help> |
4 | 79 <![CDATA[ |
3 | 80 **What it does** |
81 | |
6 | 82 This tool performs find & replace operation on a specified file. |
3 | 83 |
84 .. class:: infomark | |
85 | |
86 The **pattern to find** uses the **extended regular** expression syntax (same as running 'sed -r'). | |
87 | |
88 .. class:: infomark | |
89 | |
90 **TIP:** If you need more complex patterns, use the *sed* tool. | |
91 | |
92 ----- | |
93 | |
94 **Examples of Find Patterns** | |
95 | |
96 - **HELLO** The word 'HELLO' (case sensitive). | |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
97 - **AG.T** The letters A,G followed by any single character, followed by the letter T. |
3 | 98 - **A{4,}** Four or more consecutive A's. |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
99 - **chr2[012]\\t** The words 'chr20' or 'chr21' or 'chr22' followed by a tab character. |
3 | 100 - **hsa-mir-([^ ]+)** The text 'hsa-mir-' followed by one-or-more non-space characters. When using parenthesis, the matched content of the parenthesis can be accessed with **\1** in the **replace** pattern. |
101 | |
102 | |
103 **Examples of Replace Patterns** | |
104 | |
105 - **WORLD** The word 'WORLD' will be placed whereever the find pattern was found. | |
14
7725ab6dab67
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b'e6ee273f75fff61d1e419283fa8088528cf59470\n'
bgruening
parents:
13
diff
changeset
|
106 - **FOO-&-BAR** Each time the find pattern is found, it will be surrounded with 'FOO-' at the beginning and '-BAR' at the end. **&** (ampersand) represents the matched find pattern. |
3 | 107 - **\\1** The text which matched the first parenthesis in the Find Pattern. |
108 | |
109 | |
110 ----- | |
111 | |
112 **Example 1** | |
113 | |
114 **Find Pattern:** HELLO | |
115 **Replace Pattern:** WORLD | |
116 | |
117 Every time the word HELLO is found, it will be replaced with the word WORLD. | |
118 | |
119 | |
120 ----- | |
121 | |
122 **Example 2** | |
123 | |
7 | 124 **Find Pattern:** ^(.{4}) |
6 | 125 **Replace Pattern:** &\\t |
3 | 126 |
127 Find the first four characters in each line, and replace them with the same text, followed by a tab character. In practice - this will split the first line into two columns. | |
128 | |
129 | |
130 ----- | |
131 | |
19
bed2226b90f7
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit 29899be24c03f631ef3be107fd60e9f898806321
bgruening
parents:
18
diff
changeset
|
132 **Extended Regular Expression Syntax** |
3 | 133 |
7 | 134 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. |
3 | 135 |
136 - **( ) { } [ ] . * ? + \ ^ $** are all special characters. **\\** can be used to "escape" a special character, allowing that special character to be searched for. | |
137 - **^** matches the beginning of a string(but not an internal line). | |
138 - **(** .. **)** groups a particular pattern. | |
139 - **{** n or n, or n,m **}** specifies an expected number of repetitions of the preceding pattern. | |
140 | |
141 - **{n}** The preceding item is matched exactly n times. | |
7 | 142 - **{n,}** The preceding item ismatched n or more times. |
143 - **{n,m}** The preceding item is matched at least n times but not more than m times. | |
3 | 144 |
145 - **[** ... **]** 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**. | |
146 - **.** Matches any single character except a newline. | |
147 - ***** The preceding item will be matched zero or more times. | |
148 - **?** The preceding item is optional and matched at most once. | |
149 - **+** The preceding item will be matched one or more times. | |
150 - **^** has two meaning: | |
7 | 151 - matches the beginning of a line or string. |
3 | 152 - indicates negation in a character class. For example, [^...] matches every character except the ones inside brackets. |
153 - **$** matches the end of a line or string. | |
7 | 154 - **\|** Separates alternate possibilities. |
3 | 155 |
156 | |
157 **Note**: SED uses extended regular expression syntax, not Perl syntax. **\\d**, **\\w**, **\\s** etc. are **not** supported. | |
158 | |
4 | 159 @REFERENCES@ |
160 ]]> | |
3 | 161 </help> |
14
7725ab6dab67
planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/text_processing/text_processing commit b'e6ee273f75fff61d1e419283fa8088528cf59470\n'
bgruening
parents:
13
diff
changeset
|
162 <expand macro="citations" /> |
3 | 163 </tool> |