annotate export_to_metexp_tabular.xml @ 2:44bfd7e34b39

added comment
author pieter.lukasse@wur.nl
date Thu, 19 Mar 2015 10:39:27 +0100
parents dffc38727496
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool id="export_to_metexp_tabular"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
2 name="METEXP - Tabular file"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
3 version="0.2.0">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
4 <description>Create tabular file for loading into METabolomics EXPlorer database</description>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
5 <command interpreter="python">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
6 export_to_metexp_tabular.py
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
7 $rankfilter_and_caslookup_combi
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
8 $msclust_quant_file
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
9 $output_result
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
10 "$organism"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
11 "$tissue"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
12 "$experiment_name"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
13 "$user_name"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
14 "$column_type"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
15 </command>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
16 <inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
17 <param format="tabular" name="rankfilter_and_caslookup_combi" type="data" label="RIQC-Combine RankFilter and CasLookup output"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
18 help="Select the (multi) output file from the 'Combine RankFilter and CasLookup' tool"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
19 <param format="tabular" name="msclust_quant_file" type="data" label="MusClust-quantification file output"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
20 help="Select the output file from MsClust (centrotype, mic or sim) which also contain respective spectrum details"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
21
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
22
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
23 <param name="organism" type="text" size="80"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
24 label="Organism(s) info"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
25 help="Metadata information to accompany the results when stored in MetExp DB." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
26 <validator type="empty_field" message="A value is required."></validator><!-- attribute optional="False" does not seem to work for params so validator is added -->
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
27 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
28
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
29 <param name="tissue" type="text" size="80"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
30 label="Tissue(s) info"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
31 help="Metadata information to accompany the results when stored in MetExp DB." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
32 <validator type="empty_field" message="A value is required."></validator>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
33 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
34
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
35 <param name="experiment_name" type="text" size="80"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
36 label="Experiment name/code"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
37 help="Name or code to store the results under. This can help you find the results back in MetExpDB." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
38 <validator type="empty_field" message="A value is required."></validator>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
39 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
40
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
41 <param name="user_name" type="text" size="80"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
42 label="User name"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
43 help="User name or code to store the results under. This can help you find the results back in MetExpDB." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
44 <validator type="empty_field" message="A value is required."></validator>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
45 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
46
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
47 <param name="column_type" type="text" size="80"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
48 label="Column type"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
49 help="Column type to report with the results. This can help you find the results back in MetExpDB." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
50 <validator type="empty_field" message="A value is required."></validator>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
51 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
52
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
53 </inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
54 <outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
55 <data format="tabular" label="${tool.name} on ${on_string}" name="output_result" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
56 </outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
57 <help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
58 .. class:: infomark
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
59
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
60 Tool to combine output from the tools RankFilter, CasLookup and MsClust
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
61 into a tabular file that can be uploaded to the METabolomics EXPlorer (MetExp) database.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
62
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
63 RankFilter, CasLookup are already combined by 'RIQC-Combine RankFilter and CasLookup' tool so here we will use
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
64 this result.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
65
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
66 **Notes**
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
67
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
68 Extra calculations performed:
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
69 - The columns MM and MW are also added here and are derived from the column FORMULA found in RankFilter, CasLookup combined result.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
70
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
71 So in total here we merge 2 files and calculate one new column.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
72
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
73
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
74 </help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
75 </tool>