annotate column_regex_substitution.xml @ 0:8d8511030ebf draft default tip

planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
author blankenberg
date Fri, 07 Sep 2018 10:28:07 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
1 <tool id="column_regex_substitution" name="Column substitution" version="0.0.1">
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
2 <description>by regular expressions</description>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
3 <requirements>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
4 <requirement type="package" version="2.7">python</requirement>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
5 </requirements>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
6 <stdio>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
7 <exit_code range="1:" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
8 <exit_code range=":-1" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
9 </stdio>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
10 <version_command>python column_regex_substitution.py --version</version_command>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
11 <command><![CDATA[
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
12 #import pipes
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
13 python '$__tool_directory__/column_regex_substitution.py'
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
14 --input '${input_tabular}'
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
15 --pattern ${pipes.quote( str( $pattern ).replace('\\','\\\\').decode( 'string_escape' ) ) or '""'}
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
16 --replacement ${ pipes.quote( str( $replacement ).replace('\\','\\\\').decode( 'string_escape' ) ) or '""' }
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
17 --columns '${ $columns or "" }'
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
18 --output '${outfile}'
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
19 #if $input_tabular.metadata.delimiter:
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
20 --delimiter ${ pipes.quote( str( $input_tabular.unsanitized.metadata.delimiter ) ) }
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
21 #end if
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
22 --column_offset '-1'
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
23 ]]>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
24 </command>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
25 <inputs>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
26 <param name="input_tabular" type="data" format="txt" label="File to perform substitution on" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
27 <param name="pattern" type="text" label="Pattern to Match">
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
28 <sanitizer sanitize="False" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
29 </param>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
30 <param name="replacement" type="text" label="Replacement">
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
31 <sanitizer sanitize="False" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
32 </param>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
33 <param name="columns" label="Columns for substitution" type="data_column" data_ref="input_tabular" optional="True" multiple="True" help="Selecting no columns will target all columns"/>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
34 </inputs>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
35 <outputs>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
36 <data name="outfile" format_source="input_tabular" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
37 </outputs>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
38 <tests>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
39 <test>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
40 <param name="input_tabular" ftype="tabular" value="column_regex_substitution_in.tabular"/>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
41 <param name="pattern" value="^$"/>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
42 <param name="replacement" value="."/>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
43 <param name="columns" value="1"/>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
44 <output name="outfile" ftype="tabular" file="column_regex_substitution_out.tabular" />
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
45 </test>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
46 </tests>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
47 <help><![CDATA[
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
48 **What it does**
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
49
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
50 Use regular expressions (regex) to substitute field values. Datasets that do not have a metadata delimiter value will be treated as a single column per row.
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
51
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
52 This tool makes use of Python's `re.sub functionality <https://docs.python.org/2/library/re.html#re.sub>`_.
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
53
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
54 ]]>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
55 </help>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
56 <citations></citations>
8d8511030ebf planemo upload for repository https://github.com/blankenberg/tools-blankenberg/tree/master/tools/column_regex_substitution commit 78936dc6be1747303d4cbfd80d09e4cfd1cbf292
blankenberg
parents:
diff changeset
57 </tool>