annotate bih4maconda.xml @ 0:de13e2c45971 draft

Init repository for bih4maconda
author fgiacomoni
date Tue, 21 Jan 2020 15:49:00 -0500
parents
children 2744d20c830a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
1 <tool id="bih4maconda" name="Bih4MaConDa" version="0.1.3">
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
2 <description>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
3 : Utility to detect potential contaminants in your peak list based on MaConDa database
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
4 </description>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
5 <requirements>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
6 <requirement type="package" version="0.2.0">perl-metabolomics-fragment-annotation</requirement>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
7 </requirements>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
8 <stdio>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
9 <exit_code range="1" level="fatal" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
10 </stdio>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
11
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
12 <command><![CDATA[
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
13 perl $__tool_directory__/bih4maconda.pl
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
14 -input $variableMetadata_in
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
15 -mzCol $colmass
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
16
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
17 #if str($has_header.header_choice) == "YES":
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
18 -header "${has_header.header}"
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
19 #end if
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
20
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
21 -ppmError $ppm_error
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
22 -mode $mode
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
23 -outputTab $outputTab
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
24 -outputFull $outFull
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
25 -verbose $verbose
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
26 ]]></command>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
27 <inputs>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
28 <param name="variableMetadata_in" type="data" label="Input file containing a list of mzs (format: tabular)" help="Generally variable metadata file" format="tabular" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
29
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
30 <conditional name="has_header">
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
31 <param name="header_choice" type="boolean" checked="true" truevalue="YES" falsevalue="NO" label="Do you have a header?" help="if 'YES' is selected then enter your number of header lines" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
32 <when value="YES">
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
33 <param name="header" type="integer" label="Number of header lines" value="1" min="1" max="10" help="number of lines not containing masses"/>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
34 </when>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
35 <when value="NO"/>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
36 </conditional>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
37
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
38 <param name="colmass" label="Column of masses (MZ)" type="data_column" data_ref="variableMetadata_in" accept_default="true" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
39
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
40 <param name="verbose" type="select" label="Verbose level" display="radio" help="">
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
41 <option value="1" selected="true">Low</option>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
42 <option value="3" >High</option>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
43 </param>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
44
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
45
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
46 <param name="ppm_error" label="Tolerance in ppm used during annotation step" type="float" value="5" min="0" max="300000" help="Default value is 5 ppm"/>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
47
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
48 <param name="mode" label="Molecular Species " type="select" display="radio" help="">
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
49 <option value="POSITIVE">Positif Mode</option>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
50 <option value="NEGATIVE">Negatif Mode</option>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
51 <option value="NEUTRAL">Neutral Mass</option>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
52 </param>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
53
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
54 </inputs>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
55 <outputs>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
56 <data name="outFull" format="tabular" label="${variableMetadata_in.name[:-6]}.BIH4MACONDA_Full.tabular" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
57 <data name="outputTab" format="tabular" label="${variableMetadata_in.name[:-6]}.BIH4MACONDA.tabular" />
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
58 </outputs>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
59
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
60 <help><![CDATA[
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
61
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
62 .. class:: infomark
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
63
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
64 **Authors**
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
65 | Franck Giacomoni - FLAME ; PFEM ; INRA ; MetaboHUB (for original version and development of this Perl script and for xml interface and Perl wrapper)
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
66
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
67 ---------------------------------------------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
68
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
69
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
70 ======================
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
71 bih4MaDonDa
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
72 ======================
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
73
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
74 -----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
75 Description
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
76 -----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
77
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
78 | detection of potential contaminants in your peak list based on MaConDa database
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
79
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
80
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
81 Keywords
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
82 ========
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
83
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
84 contaminants
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
85
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
86
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
87 -----------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
88 Workflow position
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
89 -----------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
90
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
91
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
92 .. image::
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
93 :width: 800
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
94
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
95
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
96 -----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
97 Input files
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
98 -----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
99
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
100
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
101 +--------------------------------+-----------+
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
102 | Parameter : num + label | Format |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
103 +================================+===========+
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
104 | 1 : File with a list of masses | tabular |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
105 +--------------------------------+-----------+
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
106
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
107 File of masses (Generally variable metadata file) must have at least the following column :
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
108 | Masses : column with all the masses in the tabular input file
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
109 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
110
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
111
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
112 ----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
113 Parameters
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
114 ----------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
115
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
116 File of masses
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
117 | see "Input files" section above
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
118 | Tabular file format, Generally variable metadata file
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
119 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
120
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
121 Do you have a header
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
122 | YES (default) : parameter **Number of header lines** is visible
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
123 | NO : all lines are considered to contain masses
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
124 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
125
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
126 If 'have a header'='YES'
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
127
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
128 Number of header lines
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
129 | Number of lines not containing masses values, these lines will be ignored
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
130 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
131
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
132 In all header cases :
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
133
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
134 Column of Masses
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
135 | Specify the column number for the mz in the tabular input file
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
136 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
137
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
138
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
139 In all cases :
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
140
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
141 PPM error
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
142 | Specify a delta (in ppm) to apply on annotating mass - This value is a float.
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
143 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
144
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
145
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
146 ------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
147 Output files
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
148 ------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
149
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
150 Two types of files (if you manually enter the masses both files are mingled):
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
151 | BIH4MACONDA_(input.name)_FULL.tabular : for linking with others modules.
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
152 | BIH4MACONDA_(input.name).tabular : an excel-like output will be available.
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
153 |
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
154
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
155
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
156 ---------------------------------------------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
157
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
158 ---------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
159 Working example
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
160 ---------------
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
161
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
162
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
163 .. class:: warningmark
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
164
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
165 Refer to the corresponding W4M HowTo section: http://workflow4metabolomics.org/howto
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
166 | Format Data For Postprocessing
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
167 | Perform LCMS Annotations
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
168
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
169 .. class:: warningmark
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
170
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
171 And their "W4M courses 2018":
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
172 | Using Galaxy4Metabolomics - W4M table format for Galaxy
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
173 | Annotation Banks - Annotation
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
174
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
175 ]]></help>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
176 <citations>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
177 <citation type="doi">10.1093/bioinformatics/bts527</citation>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
178 </citations>
de13e2c45971 Init repository for bih4maconda
fgiacomoni
parents:
diff changeset
179 </tool>