Source code

Download source archive ↓

upstream-extended/community/tools/text_processing/column_arrange_by_header/columnArrange.xml

1<tool id="bg_column_arrange_by_header" name="Column arrange" version="0.3" profile="25.0">
2    <description>by header name</description>
3    <requirements>
4        <requirement type="package" version="3.14">python</requirement>
5    </requirements>
6    <required_files>
7        <include path="column_arrange.py" />
8    </required_files>
9    <command>
10    <![CDATA[
11        python '$__tool_directory__/column_arrange.py'
12          --columns
13        #for token in $rep_param_columns:
14            '$token.param_column'
15        #end for
16        --in '$param_input'
17        --out '$output'
18        $discard_remaining
19    ]]>
20    </command>
21    <inputs>
22        <param format="tabular" name="param_input" type="data" label="file to rearrange" />
23        <repeat name ="rep_param_columns" min="1" title="Specify the first few columns by name">
24            <param name="param_column" type="text" value="" label="column">
25                <sanitizer>
26                    <valid initial="string.printable">
27                        <remove value="&apos;"/>
28                    </valid>
29                    <mapping initial="none">
30                        <add source="&apos;" target="&apos;&quot;&apos;&quot;&apos;" />
31                    </mapping>
32                </sanitizer>
33            </param>
34        </repeat>
35        <param name="discard_remaining" type="boolean" truevalue="--discard" falsevalue="" checked="false"
36        label="Discard unspecified columns?"
37        help="Columns not explicitly specified above for rearrangement can be appended after the last specified column in their original order (the default) or be discarded from the output." />
38    </inputs>
39    <outputs>
40        <data format="tabular" name="output" />
41    </outputs>
42    <tests>
43        <test>
44            <param name="param_input" value="columnarrange_input1.tab"/>
45            <repeat name="rep_param_columns">
46                <param name="param_column" value="fname"/>
47            </repeat>
48            <repeat name="rep_param_columns">
49                <param name="param_column" value="age"/>
50            </repeat>
51            <output name="output" file="columnarrange_result1.tab"/>
52        </test>
53        <test>
54            <param name="param_input" value="columnarrange_input1.tab"/>
55            <repeat name="rep_param_columns">
56                <param name="param_column" value="fname"/>
57            </repeat>
58            <param name="discard_remaining" value="true" />
59            <output name="output">
60                <assert_contents>
61                    <has_n_columns n="1" />
62                    <has_line line="fname" />
63                </assert_contents>
64            </output>
65        </test>
66        <test>
67            <param name="param_input" value="columnarrange_input1.tab"/>
68            <repeat name="rep_param_columns">
69                <param name="param_column" value="fname"/>
70            </repeat>
71            <repeat name="rep_param_columns">
72                <param name="param_column" value="age"/>
73            </repeat>
74            <param name="discard_remaining" value="true" />
75            <output name="output">
76                <assert_contents>
77                    <has_n_columns n="2" />
78                    <has_line line="fname&#009;age" />
79                </assert_contents>
80            </output>
81        </test>
82        <test>
83            <param name="param_input" value="columnarrange_input2.tab"/>
84            <repeat name="rep_param_columns">
85                <param name="param_column" value="first name"/>
86            </repeat>
87            <repeat name="rep_param_columns">
88                <param name="param_column" value="nationality"/>
89            </repeat>
90            <output name="output" file="columnarrange_result2.tab"/>
91        </test>
92    </tests>
93    <help>
94**What it does**
95
96With this tool you can specify - by name - the order of columns for tabular
97data.
98Columns not specified will remain ordered as before and be moved to the right
99of the specified columns, as shown in the following example.
100
101Input file::
102
103    AHeader BHeader CHeader DHeader
104    a       b       c       d
105    a       b       c       d
106
107Specifying **CHeader** and **BHeader**, as the columns that should be leftmost,
108generates::
109
110    CHeader BHeader AHeader DHeader
111    c       b       a       d
112    c       b       a       d
113
114Alternatively, you can choose to retain *only* the specified columns in their
115new arrangement and discard all other columns.
116    </help>
117    <citations>
118        <citation type="bibtex">
119            @ARTICLE{bgruening_galaxytools,
120                Author = {Björn Grüning, Cameron Smith, Torsten Houwaart, Nicola Soranzo, Helena Rasche},
121                keywords = {bioinformatics, ngs, galaxy, cheminformatics, rna},
122                title = {{Galaxy Tools - A collection of bioinformatics and cheminformatics tools for the Galaxy environment}},
123                url = {https://github.com/bgruening/galaxytools}
124            }
125        </citation>
126    </citations>
127</tool>