annotate library_lookup.xml @ 1:223d1167de58

added comment
author pieter.lukasse@wur.nl
date Thu, 19 Mar 2015 10:38:48 +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="lookup_library" name="RIQC-Lookup RI for CAS numbers in library" version="1.0.2">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description>Lookup or estimate the RI using a "known RI values" CAS numbers library</description>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
3 <command interpreter="python">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
4 library_lookup.py
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
5 $library_file
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
6 $input
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
7 "$col_type"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
8 "$polarity"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
9 $output
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
10 #for $ctype in $pref
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
11 ${ctype.columntype}
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
12 #end for
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
13 $regression.model
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
14 </command>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
15 <inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
16 <!-- Regarding the <page> items: this blocks the use of this tool in Galaxy workflows. However,
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
17 alternatives like wrapping this in conditionals, repeats (to force a refresh_on_change as this option
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
18 is not working on its own) failed since the workflow editor does not support refreshes...not does the
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
19 workflow runtime support conditionals or repeats to be set at runtime. See also
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
20 galaxy-dev mail thread "when else" in <conditional> ? RE: refresh_on_change : is this a valid attribute? Any other ideas/options??" -->
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
21 <page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
22 <param format="tabular" name="input" type="data" label="NIST identifications as tabular file"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
23 help="Select a tab delimited NIST metabolite identifications file (converted from PDF)" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
24 <param name="library_file" type="select" label="CAS x RI Library file"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
25 help="Select a library/lookup file containing RI values for CAS numbers on various chromatography columns "
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
26 dynamic_options='get_directory_files("tool-data/shared/PRIMS-metabolomics/RI_DB_libraries")'/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
27 </page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
28 <page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
29 <param name="col_type" type="select" label="Select column type" refresh_on_change="true"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
30 display="radio" dynamic_options='get_column_type(library_file)'
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
31 help="" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
32 </page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
33 <page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
34 <param name="polarity" type="select" label="Select polarity" refresh_on_change="true"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
35 display="radio" dynamic_options='filter_column(library_file,col_type)'
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
36 help="" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
37 </page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
38 <page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
39 <conditional name="regression">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
40 <param name="regression_select" type="boolean" checked="false" label="Apply regression method"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
41 help="If no data for the selected column is present in the database, selecting this option will try
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
42 to convert Retention Indices using data from other GC-columns with a regression method. Please
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
43 note that only the first given GC-column above will be used for this, any alternatives will be
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
44 ignored" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
45 <when value="true">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
46 <param name="model" format="tabular" type="data" label="Tabular file containing regression model"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
47 help="This file contains the coefficients used to perform the regression from one GC-column
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
48 to another GC-column"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
49 </when>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
50 <when value="false">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
51 <param name="model" type="hidden" value="False" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
52 </when>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
53 </conditional>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
54 <repeat name="pref" title="Select column name preference">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
55 <param name="columntype" type="select" label="Column name" refresh_on_change="true"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
56 dynamic_options='filter_column2(library_file, col_type, polarity)'
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
57 help="Select one or more column names for filtering. The order defines the priority." />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
58 </repeat>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
59 </page>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
60 </inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
61 <outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
62 <data format="tabular" label="${tool.name} on" name="output" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
63 </outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
64 <code file="match_library.py" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
65 <help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
66 Performs a lookup of the RI values by matching CAS numbers from the given NIST identifications file to a library.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
67 If a direct match is NOT found for the preferred column name, a regression can be done to find
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
68 the theoretical RI value based on known RI values for the CAS number on other column types (see step 4).
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
69 If there is no match for the CAS number on any column type, then the record is not given a RI.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
70
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
71
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
72
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
73 </help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
74
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
75 </tool>