annotate TableMerge/tablemerge.xml @ 1:e44c5246247a draft default tip

Uploaded
author melpetera
date Thu, 14 Nov 2019 12:33:41 -0500
parents 902ab790fb7b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
1 <tool id="tablemerge" name="Table Merge" version="1.0.1">
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
2 <description>Merging dataMatrix with a metadata table</description>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
3 <requirements>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
4 <requirement type="package" version="1.1_4">r-batch</requirement>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
5 </requirements>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
6 <command interpreter="Rscript">
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
7 tablemerge_wrap.R
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
8 dataMatrix_in "$dataMatrix_in"
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
9 Metadata_in "$Metadata_in"
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
10
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
11 metatype "$metatype"
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
12
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
13 combined_out "$combined_out"
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
14
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
15 </command>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
16
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
17 <inputs>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
18 <param name="dataMatrix_in" type="data" label="Data matrix file" help="" format="tabular" />
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
19 <param name="Metadata_in" type="data" label="Metadata file" help="Sample metadata or variable metadata" format="tabular" />
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
20
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
21 <param name="metatype" label="Type of metadata" type="select" display="radio" help="">
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
22 <option value="sample">Sample metadata</option>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
23 <option value="variable">Variable metadata</option>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
24 </param>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
25
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
26 </inputs>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
27
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
28 <outputs>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
29 <data name="combined_out" label="Combined_${Metadata_in.name}" format="tabular" ></data>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
30 </outputs>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
31
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
32 <tests>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
33 <test>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
34 <param name="dataMatrix_in" value="input_TM12_dataMatrix.txt"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
35 <param name="Metadata_in" value="input_TM1_variableMetadata.txt"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
36 <param name="metatype" value="variable"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
37 <output name="combined_out" file="output_TM1_expected.tabular"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
38 </test>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
39 <test>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
40 <param name="dataMatrix_in" value="input_TM12_dataMatrix.txt"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
41 <param name="Metadata_in" value="input_TM2_sampleMetadata.txt"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
42 <param name="metatype" value="sample"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
43 <output name="combined_out" file="output_TM2_expected.tabular"/>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
44 </test>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
45 </tests>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
46
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
47
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
48 <help>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
49
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
50 .. class:: infomark
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
51
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
52 **Authors**
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
53 | Melanie Petera - PFEM ; INRA ; MetaboHUB
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
54
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
55 ---------------------------------------------------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
56
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
57 ========================
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
58 Table Merge
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
59 ========================
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
60
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
61 -----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
62 Description
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
63 -----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
64
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
65 Merges the data matrix with a selected metadata file (sample metadata or variable metadata)
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
66 to obtain a single file.
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
67
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
68
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
69
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
70 -----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
71 Input files
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
72 -----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
73
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
74 +----------------------------+---------+
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
75 | Parameter : num + label | Format |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
76 +============================+=========+
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
77 | 1 : Data matrix file | tabular |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
78 +----------------------------+---------+
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
79 | 2 : Metadata file | tabular |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
80 +----------------------------+---------+
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
81
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
82
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
83 Data matrix file contains the intensity values of the variables.
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
84 |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
85
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
86 Metadata file is meant to be chosen from sample metadata and variable metadata files.
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
87 |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
88
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
89 ----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
90 Parameter
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
91 ----------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
92
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
93 Type of metadata
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
94 | Specify which type of metadata table is given as Metadata file
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
95 |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
96
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
97
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
98 ------------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
99 Output file
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
100 ------------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
101
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
102
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
103 Combined_Metadata
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
104 | tabular output
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
105 | Corresponds to the input metadata file completed as new columns by the intensities in the input data matrix file
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
106 |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
107
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
108
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
109 ---------------------------------------------------
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
110
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
111
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
112 .. class:: warningmark
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
113
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
114 For more information about input files, refer to the corresponding "W4M HowTo" page:
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
115 | `W4M table format for Galaxy &lt;http://workflow4metabolomics.org/sites/workflow4metabolomics.org/files/files/w4m_TableFormatForGalaxy_150908.pdf&gt;`_
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
116 |
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
117
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
118
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
119
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
120
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
121 </help>
902ab790fb7b Uploaded
melpetera
parents:
diff changeset
122 </tool>