Mercurial > repos > lecorguille > xcms_xcmsset
annotate abims_xcms_xcmsSet.xml @ 13:68547432079b draft
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
| author | lecorguille |
|---|---|
| date | Wed, 06 Jul 2016 17:42:16 -0400 |
| parents | 00ef27ba8abd |
| children | 1a9bbd4670e8 |
| rev | line source |
|---|---|
|
13
68547432079b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
1 <tool id="abims_xcms_xcmsSet" name="xcms.xcmsSet" version="2.0.9"> |
| 0 | 2 |
| 3 <description>Filtration and Peak Identification using xcmsSet function from xcms R package to preprocess LC/MS data for relative quantification and statistical analysis </description> | |
| 4 | |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
5 <macros> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
6 <import>macros.xml</import> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
7 </macros> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
8 |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
9 <expand macro="requirements"/> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
10 <expand macro="stdio"/> |
| 0 | 11 |
| 1 | 12 <command><![CDATA[ |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
13 @COMMAND_XCMS_SCRIPT@ |
| 0 | 14 #if $inputs.input == "lib": |
| 15 library $__app__.config.user_library_import_dir/$__user_email__/$inputs.library | |
| 16 #elif $inputs.input == "zip_file": | |
| 17 zipfile $inputs.zip_file | |
| 18 #end if | |
| 19 | |
| 20 xfunction xcmsSet | |
| 1 | 21 |
| 22 xsetRdataOutput $xsetRData | |
| 23 sampleMetadataOutput $sampleMetadata | |
| 24 ticspdf $ticsRawPdf | |
| 25 bicspdf $bpcsRawPdf | |
| 26 | |
| 0 | 27 ## profmethod $profmethod |
| 28 nSlaves \${GALAXY_SLOTS:-1} method $methods.method | |
| 29 #if $methods.method == "centWave": | |
| 30 ppm $methods.ppm | |
| 31 peakwidth "c($methods.peakwidth)" | |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
32 #if $methods.options_scanrange.option == "show": |
| 0 | 33 scanrange "c($methods.options_scanrange.scanrange)" |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
34 #end if |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
35 #if $methods.options_c.option == "show": |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
36 mzdiff $methods.options_c.mzdiff |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
37 snthresh $methods.options_c.snthresh |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
38 integrate $methods.options_c.integrate |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
39 noise $methods.options_c.noise |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
40 prefilter "c($methods.options_c.prefilter)" |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
41 #end if |
| 0 | 42 #elif $methods.method == "matchedFilter": |
| 43 step $methods.step | |
| 44 fwhm $methods.fwhm | |
| 45 #if $methods.options_m.option == "show": | |
| 46 ## sigma "$methods.options_m.sigma" | |
| 47 max $methods.options_m.max | |
| 48 snthresh $methods.options_m.snthresh | |
| 49 ## mzdiff $methods.options_m.mzdiff | |
| 50 steps $methods.options_m.steps | |
| 51 ## sleep $methods.options_m.sleep | |
| 52 #end if | |
| 53 #elif $methods.method == "MSW": | |
| 54 snthr $methods.snthr | |
| 55 nearbyPeak $methods.nearbyPeak | |
| 56 winSize.noise $methods.winSize_noise | |
| 57 amp.Th $methods.amp_Th | |
| 58 scales "c($methods.scales)" | |
| 59 SNR.method "$methods.SNR_method" | |
| 60 #end if | |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
61 @COMMAND_LOG_EXIT@ |
| 1 | 62 ]]></command> |
| 0 | 63 |
| 64 <inputs> | |
| 65 | |
| 66 <conditional name="inputs"> | |
| 67 <param name="input" type="select" label="Choose your inputs method" > | |
| 68 <option value="zip_file" selected="true">Zip file from your history containing your chromatograms</option> | |
| 69 <option value="lib" >Library directory name</option> | |
| 70 </param> | |
| 71 <when value="zip_file"> | |
| 4 | 72 <param name="zip_file" type="data" format="no_unzip.zip,zip" label="Zip file" /> |
| 0 | 73 </when> |
| 74 <when value="lib"> | |
| 75 <param name="library" type="text" size="40" label="Library directory name" help="The name of your directory containing all your data" > | |
| 76 <validator type="empty_field"/> | |
| 77 </param> | |
| 78 </when> | |
| 79 | |
| 80 </conditional> | |
| 81 | |
| 82 | |
| 83 <!-- | |
| 84 <param name="profmethod" type="select" label="Method to use for profile generation (profmethod)" > | |
| 85 <option value="bin" selected="true">bin</option> | |
| 86 <option value="binlin">binlin</option> | |
| 87 <option value="binlinbase">binlinbase</option> | |
| 88 <option value="intlin">intlin</option> | |
| 89 </param> | |
| 90 <param name="nSlaves" type="integer" value="9" label="MPI-slaves CPU" help="number of MPI-slaves to use for parallel peak detection" /> | |
| 91 --> | |
| 92 <conditional name="methods"> | |
| 93 <param name="method" type="select" label="Extraction method for peaks detection" help="[method] See the help section below"> | |
| 94 <option value="centWave" >centWave</option> | |
| 95 <option value="matchedFilter" selected="true">matchedFilter</option> | |
| 96 <option value="MSW">MSW</option> | |
| 97 </param> | |
| 98 | |
| 99 <!-- centWave Filter options --> | |
| 100 <when value="centWave"> | |
| 101 <param name="ppm" type="integer" value="25" label="Max tolerated ppm m/z deviation in consecutive scans in ppm" help="[ppm]" /> | |
| 102 <param name="peakwidth" type="text" value="20,50" label="Min,Max peak width in seconds" help="[peakwidth]" /> | |
| 103 <conditional name="options_scanrange"> | |
| 104 <param name="option" type="select" label="Scan range option " > | |
| 105 <option value="show">show</option> | |
| 106 <option value="hide" selected="true">hide</option> | |
| 107 </param> | |
| 108 <when value="show"> | |
| 109 <param name="scanrange" type="text" value="" label="scanrange" help="scan range to process, for example (16,365)" > | |
| 110 <validator type="empty_field"/> | |
| 111 </param> | |
| 112 </when> | |
| 1 | 113 <when value="hide"> |
| 114 </when> | |
| 0 | 115 </conditional> |
| 116 | |
| 117 <conditional name="options_c"> | |
| 118 <param name="option" type="select" label="Advanced options" > | |
| 119 <option value="show">show</option> | |
| 120 <option value="hide" selected="true">hide</option> | |
| 121 </param> | |
| 122 <when value="show"> | |
| 123 <param name="snthresh" type="integer" value="10" label="Signal/Noise threshold" help="[snthresh] Signal to noise ratio cutoff" /> | |
| 124 <param name="mzdiff" type="float" value="-0.001" label="Min m/z difference" help="[mzdiff] Min m/z difference for peaks with overlapping RT " /> | |
| 125 <param name="integrate" type="select" label="peak limits method" help="[integrate]" > | |
| 126 <option value="1">peak limits based on smoothed 2nd derivative (less precise)</option> | |
| 127 <option value="2">peak limits based on real data (more sensitive to noise)</option> | |
| 128 </param> | |
| 129 <param name="prefilter" type="text" value="3,100" label="Prefilter step for the first phase" help="[prefilter] Separate by coma k,I. Mass traces are only retained if they contain at least ‘k’ peaks with intensity >= ‘I’"/> | |
| 130 <param name="noise" type="integer" value="0" label="Noise filter" help="[noise] optional argument which is useful for data that was centroided without any intensity threshold, centroids with intensity smaller than ‘noise’ are omitted from ROI detection"/> | |
| 131 </when> | |
| 1 | 132 <when value="hide"> |
| 133 </when> | |
| 0 | 134 </conditional> |
| 135 </when> | |
| 136 | |
| 137 <!-- matched Filter options --> | |
| 138 <when value="matchedFilter"> | |
| 139 <param name="step" type="float" value="0.01" label="Step size to use for profile generation" help="[step] The peak detection algorithm creates extracted ion base peak chromatograms (EIBPC) on a fixed step size" /> | |
| 140 <param name="fwhm" type="integer" value="30" label="Full width at half maximum of matched filtration gaussian model peak" help="[fwhm] Only used to calculate the actual sigma" /> | |
| 141 <conditional name="options_m"> | |
| 142 <param name="option" type="select" label="Advanced options" > | |
| 143 <option value="show">show</option> | |
| 144 <option value="hide" selected="true">hide</option> | |
| 145 </param> | |
| 146 <when value="show"> | |
| 147 <!-- | |
| 148 <param name="sigma" type="hidden" value="fwhm/2.3548" label="sigma" help="standard deviation (fwhm/2.3548)" /> | |
| 149 --> | |
| 150 <param name="max" type="integer" value="5" label="Maximum number of peaks per extracted ion chromatogram" help="[max]" /> | |
| 151 <param name="snthresh" type="integer" value="10" label="Signal to noise ratio cutoff" help="[snthresh]" /> | |
| 152 <param name="steps" type="integer" value="2" label="Number of steps to merge prior to filtration" help="[steps] The peak identification algorithm combines a given number of EIBPCs prior to filtration and peak detection, as defined by the steps argument" /> | |
| 153 <!-- | |
| 154 <param name="mzdiff" type="text" size="20" value="0.8-step*steps" label="m/z difference" help="min m/z difference for peaks with overlapping RT " /> | |
| 155 --> | |
| 156 </when> | |
| 1 | 157 <when value="hide"> |
| 158 </when> | |
| 0 | 159 </conditional> |
| 160 </when> | |
| 161 | |
| 162 <!-- MSW Filter options --> | |
| 163 <when value="MSW"> | |
| 164 <param name="nearbyPeak" type="select" label="Determine whether to include the nearby small peaks of major peaks" help="[nearbyPeak]" > | |
| 165 <option value="TRUE">TRUE</option> | |
| 166 <option value="FALSE">FALSE</option> | |
| 167 </param> | |
| 168 <param name="winSize_noise" type="integer" value="500" label="The local window size to estimate the noise level" help="[winSize.noise]" /> | |
| 169 <param name="snthr" type="integer" value="3" label="SNR (Signal to Noise Ratio) threshold" help="[snthr]" /> | |
| 170 <param name="amp_Th" type="float" value="0.002" label="Minimum required relative amplitude of the peak" help="[amp.Th] Ratio to the maximum of CWT coefficients" /> | |
| 171 <param name="scales" type="text" value="seq(1,22,3)" label="Scales for the Continuous Wavelet Transform (CWT)" help="[scales] Scales are linked to the width of the peaks that are to be detected. Tape as indicaded seq('n,n,n') or c(n,n) : seq(from, to, by steps), c - linear vector " /> | |
| 172 <param name="SNR_method" type="text" value="data.mean" label="SNR (Signal to Noise Ratio) method" help="[SNR.method] Method to estimate noise level. Currently, only 95 percentage quantile is supported." /> | |
| 173 </when> | |
| 174 </conditional> | |
| 175 </inputs> | |
| 176 | |
| 177 <outputs> | |
| 178 <data name="xsetRData" format="rdata.xcms.raw" label="xset.RData" /> | |
| 179 <data name="sampleMetadata" format="tabular" label="sampleMetadata.tsv" /> | |
| 180 <data name="ticsRawPdf" format="pdf" label="xset.TICs_raw.pdf" /> | |
| 181 <data name="bpcsRawPdf" format="pdf" label="xset.BPCs_raw.pdf" /> | |
| 182 <data name="log" format="txt" label="xset.log.txt" /> | |
| 183 </outputs> | |
| 184 | |
| 185 <tests> | |
|
10
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
186 <!--<test> |
|
5
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
187 <param name="inputs|input" value="zip_file" /> |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
188 <param name="inputs|zip_file" value="sacuri_dir_root.zip" ftype="zip" /> |
|
5
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
189 <param name="methods|method" value="matchedFilter" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
190 <param name="methods|step" value="0.01" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
191 <param name="methods|fwhm" value="4" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
192 <param name="methods|options_m|option" value="show" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
193 <param name="methods|options_m|max" value="50" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
194 <param name="methods|options_m|snthresh" value="1" /> |
|
b9a87af62223
planemo upload commit 5a5b747865d7fb76f711bce2d9ce2a0f82a2a374-dirty
lecorguille
parents:
4
diff
changeset
|
195 <param name="methods|options_m|steps" value="2" /> |
| 1 | 196 <output name="log"> |
| 197 <assert_contents> | |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
198 <has_text text="object with 4 samples" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
199 <has_text text="Time range: 0.7-1139.7 seconds (0-19 minutes)" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
200 <has_text text="Mass range: 50.0021-999.9863 m/z" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
201 <has_text text="Peaks: 59359 (about 14840 per sample)" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
202 <has_text text="Peak Groups: 0" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
203 <has_text text="Sample classes: bio, blank" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
204 </assert_contents> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
205 </output> |
|
10
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
206 </test> |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
207 <test> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
208 <param name="inputs|input" value="zip_file" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
209 <param name="inputs|zip_file" value="sacuri_current_root.zip" ftype="zip" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
210 <param name="methods|method" value="centWave" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
211 <param name="methods|ppm" value="25" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
212 <param name="methods|peakwidth" value="20,50" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
213 <output name="log"> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
214 <assert_contents> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
215 <has_text text="object with 4 samples" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
216 <has_text text="Time range: 3.5-1139.2 seconds (0.1-19 minutes)" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
217 <has_text text="Mass range: 57.9756-593.4086 m/z" /> |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
218 <has_text text="Peaks: 1535 (about 384 per sample)" /> |
| 1 | 219 <has_text text="Peak Groups: 0" /> |
| 220 <has_text text="Sample classes: bio, blank" /> | |
| 221 </assert_contents> | |
| 222 </output> | |
|
10
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
223 </test>--> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
224 <test> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
225 <param name="inputs|input" value="zip_file" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
226 <param name="inputs|zip_file" value="faahKO_reduce.zip" ftype="zip" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
227 <param name="methods|method" value="centWave" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
228 <param name="methods|ppm" value="25" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
229 <param name="methods|peakwidth" value="20,50" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
230 <output name="log"> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
231 <assert_contents> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
232 <has_text text="object with 4 samples" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
233 <has_text text="Time range: 2506.1-4477.9 seconds (41.8-74.6 minutes)" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
234 <has_text text="Mass range: 200.1-600 m/z" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
235 <has_text text="Peaks: 9251 (about 2313 per sample)" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
236 <has_text text="Peak Groups: 0" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
237 <has_text text="Sample classes: KO, WT" /> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
238 </assert_contents> |
|
00ef27ba8abd
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
239 </output> |
| 0 | 240 </test> |
| 241 </tests> | |
| 242 | |
| 1 | 243 <help><![CDATA[ |
| 0 | 244 |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
245 @HELP_AUTHORS@ |
| 0 | 246 |
| 247 ============ | |
| 248 Xcms.xcmsSet | |
| 249 ============ | |
| 250 | |
| 251 ----------- | |
| 252 Description | |
| 253 ----------- | |
| 254 | |
| 255 This tool is used for preprocessing analyte data from multiple LC/MS files (formats NetCDF, mzXML and mzData). It extracts ion from each sample independently and using a statistic model, peaks are filtered and integrated. | |
| 256 You can read a tutorial on how to perform xcms preprocessing which is available here_. | |
| 257 | |
| 258 .. _here: http://web11.sb-roscoff.fr/download/w4m/howto/w4m_HowToPerformXcmsPreprocessing_v02.pdf | |
| 259 | |
| 260 | |
| 261 ----------------- | |
| 262 Workflow position | |
| 263 ----------------- | |
| 264 | |
| 265 **Upstream tools** | |
| 266 | |
| 267 ========================= ================= ======= ========= | |
| 268 Name output file format parameter | |
| 269 ========================= ================= ======= ========= | |
| 270 NA NA zip NA | |
| 271 ========================= ================= ======= ========= | |
| 272 | |
| 273 | |
| 274 **Downstream tools** | |
| 275 | |
| 276 +---------------------------+--------------------+-----------------+ | |
| 277 | Name | Output file | Format | | |
| 278 +===========================+====================+=================+ | |
| 279 |xcms.group | xset.RData | rdata.xcms.raw | | |
| 280 +---------------------------+--------------------+-----------------+ | |
| 281 |PCA ellipsoid by factors | sampleMetadata.tsv | Tabular | | |
| 282 +---------------------------+--------------------+-----------------+ | |
| 283 |Anova | sampleMetadata.tsv | Tabular | | |
| 284 +---------------------------+--------------------+-----------------+ | |
| 285 | |
| 286 | |
| 287 **Example of a metabolomic workflow** | |
| 288 | |
| 289 .. image:: XCMS_Galaxy_workflow.png | |
| 290 | |
| 291 | |
| 292 ------ | |
| 293 | |
| 294 .. class:: infomark | |
| 295 | |
| 296 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool. | |
| 297 | |
| 298 --------------------------------------------------- | |
| 299 | |
| 300 | |
| 301 | |
| 302 ----------- | |
| 303 Input files | |
| 304 ----------- | |
| 305 | |
| 306 +---------------------------+------------+ | |
| 307 | Parameter : num + label | Format | | |
| 308 +===========================+============+ | |
| 309 | 1 : Choose your inputs | zip | | |
| 310 +---------------------------+------------+ | |
| 311 | |
| 312 **Choose your inputs** | |
| 313 | |
| 314 You have two methods for your inputs: | |
| 315 | |
| 316 | Zip file (recommended): You can put a zip file containing your inputs: myinputs.zip (containing all your conditions as sub-directories). | |
| 317 | library folder: You must specify the name of your "library" (folder) created within your space project (for example: /projet/externe/institut/login/galaxylibrary/yourlibrary). Your library must contain all your conditions as sub-directories. | |
| 318 | |
| 4 | 319 Steps for creating the zip file |
| 320 ------------------------------- | |
| 321 | |
| 322 **Step1: Creating your directory and hierarchize the subdirectories** | |
| 323 | |
| 324 | |
| 325 VERY IMPORTANT: If you zip your files under Windows, you must use the 7Zip software (http://www.7-zip.org/), otherwise your zip will not be well unzipped on the platform W4M (zip corrupted bug). | |
| 326 | |
| 327 Your zip should contain all your conditions as sub-directories. For example, two conditions (mutant and wild): | |
| 328 arabidopsis/wild/01.raw | |
| 329 arabidopsis/mutant/01.raw | |
| 330 | |
| 331 **Step2: Creating a zip file** | |
| 332 | |
| 333 Create your zip file (e.g.: arabidopsis.zip). | |
| 334 | |
| 335 **Step 3 : Uploading it to our Galaxy server** | |
| 336 | |
| 337 If your zip file is less than 2Gb, you get use the Get Data tool to upload it. | |
| 338 | |
| 339 Otherwise if your zip file is larger than 2Gb, please refer to the HOWTO on workflow4metabolomics.org (http://application.sb-roscoff.fr/download/w4m/howto/galaxy_upload_up_2Go.pdf). | |
| 340 | |
| 341 For more informations, don't hesitate to send us an email at supportATworkflow4metabolomics.org). | |
| 342 | |
| 343 Advices for converting your files for the XCMS input | |
| 344 ---------------------------------------------------- | |
| 345 | |
| 346 We recommend you to convert your raw files to **mzXML** in centroid mode (smaller files) and the files will be compatible with the xmcs centWave method. | |
| 347 | |
| 348 **We recommend you the following parameters:** | |
| 349 | |
| 350 Use Filtering: **True** | |
| 351 | |
| 352 Use Peak Picking: **True** | |
| 353 | |
| 354 Peak Peaking -Apply to MS Levels: **All Levels (1-)** : Centroid Mode | |
| 355 | |
| 356 Use zlib: **64** | |
| 357 | |
| 358 Binary Encoding: **64** | |
| 359 | |
| 360 m/z Encoding: **64** | |
| 361 | |
| 362 Intensity Encoding: **64** | |
| 363 | |
| 364 | |
| 0 | 365 ---------- |
| 366 Parameters | |
| 367 ---------- | |
| 368 | |
| 369 Extraction method for peaks detection | |
| 370 ------------------------------------- | |
| 371 | |
| 372 **Matched Filter** | |
| 373 | |
| 374 | One parameter to consider is the Gaussian model peak width used for matched filtration,an integral part of the peak detection algorithm. | |
| 375 | For a discussion of how model peak width affects the signal to noise ratio, see Danielsson et al. (2002). | |
| 376 | |
| 377 | |
| 378 **cent Wave** | |
| 379 | |
| 380 | This algorithm is most suitable for high resolution LC/{TOF,OrbiTrap,FTICR}-MS data in centroid mode. | |
| 381 | Due to the fact that peak centroids are used, a binning step is not necessary. | |
| 382 | The method is capable of detecting close-by-peaks and also overlapping peaks. Some efforts are made to detect the exact peak boundaries to get precise peak integrals. | |
| 383 | |
| 384 **MSW** | |
| 385 | |
| 386 | Wavelet based, used for direct infusion data. Continuous wavelet transform (CWT) can be used to locate chromatographic peaks on different scales. | |
| 387 | If you wish to have more details about the other parameters, you can read the following documents: | |
| 388 | -Example of preprocessing data with XCMS : http://www.bioconductor.org/packages/2.12/bioc/vignettes/xcms/inst/doc/xcmsPreprocess.pdf | |
| 389 | -Details and explanations for all the parameters of XCMS package: http://www.bioconductor.org/packages/release/bioc/manuals/xcms/man/xcms.pdf | |
| 390 | |
| 391 | |
| 392 ------------ | |
| 393 Output files | |
| 394 ------------ | |
| 395 | |
| 396 xset.TICs_raw.pdf | |
| 397 | |
| 398 | "Total Ion Chromatograms" graph in pdf format. | |
| 399 | |
| 400 xset.BPCs_raw.pdf | |
| 401 | |
| 402 | "Base Peak Chromatograms" graph in pdf format with each class samples opposed. | |
| 403 | |
| 404 sampleMetadata.tsv | |
| 405 | |
| 406 | Tabular file that contains for each sample, it's associated class and polarity (positive,negative and mixed). | |
| 407 | This file is necessary in the Anova and PCA step of the workflow. | |
| 408 | |
| 409 xset.RData: rdata.xcms.raw format | |
| 410 | |
| 411 | Rdata file that is necessary in the second step of the workflow "xcms.group". | |
| 412 | |
| 413 ------ | |
| 414 | |
| 415 .. class:: infomark | |
| 416 | |
| 417 The output file is an xset.RData file. You can continue your analysis using it in **xcms.group** tool. | |
| 418 | |
| 419 --------------------------------------------------- | |
| 420 | |
| 421 --------------- | |
| 422 Working example | |
| 423 --------------- | |
| 424 | |
| 425 Input files | |
| 426 ----------- | |
| 427 | |
| 428 | zip_file -> **sacuri.zip** | |
| 429 | |
| 430 Parameters | |
| 431 ---------- | |
| 432 | |
| 433 | Method -> **matchedFilter** | |
| 434 | step -> **0.01** | |
| 435 | fwhm -> **4** | |
| 436 | Advanced option -> **show** | |
| 437 | max: -> **50** | |
| 438 | snthresh -> **1** | |
| 439 | steps -> **2** | |
| 440 | |
| 441 | |
| 442 Output files | |
| 443 ------------ | |
| 444 | |
| 445 | **1) xset.RData: RData file** | |
| 446 | |
| 447 | **2) Example of a sampleMetadata.tsv :** | |
| 448 | |
| 449 | |
| 450 +---------------------------+------------+---------+ | |
| 451 | sampleMetadata | class | polarity| | |
| 452 +===========================+============+=========+ | |
| 453 |HU_neg_017 | bio |negative | | |
| 454 +---------------------------+------------+---------+ | |
| 455 |HU_neg_028 | bio |negative | | |
| 456 +---------------------------+------------+---------+ | |
| 457 |HU_neg_034 | bio |negative | | |
| 458 +---------------------------+------------+---------+ | |
| 459 |Blanc04 | blank |negative | | |
| 460 +---------------------------+------------+---------+ | |
| 461 |Blanc06 | blank |negative | | |
| 462 +---------------------------+------------+---------+ | |
| 463 |Blanc09 | blank |negative | | |
| 464 +---------------------------+------------+---------+ | |
| 465 | |
| 466 | |
| 467 | |
| 468 | **3) Example of xset.TICs_raw.pdf (Total Ion Chromatograms) :** | |
| 469 | |
| 470 .. image:: xcms_tics.png | |
| 471 | |
| 472 | |
| 4 | 473 --------------------------------------------------- |
| 474 | |
| 475 Changelog/News | |
| 476 -------------- | |
| 477 | |
|
13
68547432079b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
478 **Version 2.0.9 - 06/07/2016** |
|
68547432079b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
479 |
|
68547432079b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
480 - UPGRADE: upgrate the xcms version from 1.44.0 to 1.46.0 |
|
68547432079b
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
481 |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
482 **Version 2.0.8 - 06/04/2016** |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
483 |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
484 - TEST: refactoring to pass planemo test using conda dependencies |
|
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
485 |
| 4 | 486 |
| 487 **Version 2.0.7 - 10/02/2016** | |
| 488 | |
| 489 - BUGFIX: better management of errors. Datasets remained green although the process failed | |
| 490 | |
| 491 - BUGFIX/IMPROVEMENT: New checking steps around the imported data in order to raise explicte error message before or after launch XCMS: checking of bad characters in the filenames, checking of the XML integrity and checking of duplicates which can appear in the sample names during the XCMS process because of bad characters | |
| 492 | |
| 493 - BUGFIX/IMPROVEMENT: New step to check and delete bad characters in the XML: accented characters in the storage path of the mass spectrometer | |
| 494 | |
| 495 - UPDATE: refactoring of internal management of inputs/outputs | |
| 496 | |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
497 - TEST: refactoring to feed the new report tool |
| 4 | 498 |
| 499 | |
| 500 **Version 2.0.2 - 18/01/2016 | |
| 501 | |
| 502 - BUGFIX: Some zip files were tag as "corrupt" by R. We have changed the extraction mode to deal with thoses cases. | |
| 503 | |
| 504 | |
| 505 **Version 2.0.2 - 09/10/2015** | |
| 506 | |
| 507 - BUGFIX: Some users reported a bug in xcms.xcmsSet. The preprocessing stops itself and doesn't import the whole dataset contained in the zip file without warning. But meanwhile, please check your samplemetadata dataset and the number of rows. | |
| 508 | |
| 509 | |
| 510 **Version 2.0.2 - 02/06/2015** | |
| 511 | |
| 512 - NEW: The W4M workflows will now take as input a zip file to ease the transfer and to improve dataset exchange between tools and users. (See How_to_upload). The previous "Library directory name" is still available but we invite user to switch on the new zip system as soon as possible. | |
| 513 | |
| 514 - IMPROVEMENT: new datatype/dataset formats (rdata.xcms.raw, rdata.xcms.group, rdata.xcms.retcor ...) will facilitate the sequence of tools and so avoid incompatibility errors. | |
| 515 | |
| 516 - IMPROVEMENT: parameter labels have changed to facilitate their reading. | |
| 517 | |
| 1 | 518 ]]></help> |
| 0 | 519 |
|
6
60f6c208ca16
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
520 <expand macro="citation" /> |
| 0 | 521 </tool> |