Mercurial > repos > lecorguille > xcms_fillpeaks
annotate abims_xcms_fillPeaks.xml @ 9:46f62282c8d8 draft
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
| author | lecorguille |
|---|---|
| date | Mon, 25 Apr 2016 11:09:51 -0400 |
| parents | f00e39a4b0fb |
| children | 35269602a971 |
| rev | line source |
|---|---|
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
1 <tool id="abims_xcms_fillPeaks" name="xcms.fillPeaks" version="2.0.6"> |
| 0 | 2 |
| 3 <description>Integrate the signal in the region of that peak group not represented and create a new peak</description> | |
| 4 | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
5 <macros> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
6 <import>macros.xml</import> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
7 </macros> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
8 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
9 <expand macro="requirements"/> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
10 <expand macro="stdio"/> |
| 0 | 11 |
| 1 | 12 <command><![CDATA[ |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
13 @COMMAND_XCMS_SCRIPT@ |
| 1 | 14 xfunction fillPeaks |
| 15 image $image | |
| 16 | |
| 17 xsetRdataOutput $xsetRData | |
| 18 | |
| 19 method $method | |
| 20 | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
21 #if $zip_file: |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
22 zipfile $zip_file |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
23 #end if |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
24 @COMMAND_LOG_EXIT@ |
| 1 | 25 |
| 26 ]]></command> | |
| 0 | 27 |
| 28 <inputs> | |
| 29 <param name="image" type="data" format="rdata.xcms.group,rdata" label="xset RData file" help="output file from another function xcms (group)" /> | |
| 30 <param name="method" type="select" label="Filling method" help="[method] See the help section below"> | |
| 31 <option value="chrom" selected="true">chrom</option> | |
| 32 <option value="MSW" >MSW</option> | |
| 33 </param> | |
| 1 | 34 <!-- To pass planemo test --> |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
35 <param name="zip_file" type="data" format="no_unzip.zip,zip" label="Zip file" help="Use only if you get a message which say that your original zip file have been deleted on the server." /> |
| 0 | 36 </inputs> |
| 37 | |
| 38 <outputs> | |
| 39 <data name="xsetRData" format="rdata.xcms.fillpeaks" label="${image.name[:-6]}.fillPeaks.RData" /> | |
| 1 | 40 <data name="log" format="txt" label="xset.log.txt" hidden="true" /> |
| 0 | 41 </outputs> |
| 42 | |
| 43 <tests> | |
|
9
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
44 <!--<test> |
| 0 | 45 <param name="image" value="xset.group.retcor.group.RData"/> |
| 46 <param name="method" value="chrom"/> | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
47 <param name="zip_file" value="sacuri_dir_root.zip" ftype="zip" /> |
| 1 | 48 <output name="log"> |
| 49 <assert_contents> | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
50 <has_text text="object with 4 samples" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
51 <has_text text="Time range: 0.2-1140.1 seconds (0-19 minutes)" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
52 <has_text text="Mass range: 50.0021-999.9863 m/z" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
53 <has_text text="Peaks: 199718 (about 49930 per sample)" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
54 <has_text text="Peak Groups: 48958" /> |
| 1 | 55 <has_text text="Sample classes: bio, blank" /> |
| 56 </assert_contents> | |
| 57 </output> | |
|
9
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
58 </test>--> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
59 <test> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
60 <param name="image" value="faahKO.xset.group.retcor.group.RData"/> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
61 <param name="method" value="chrom"/> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
62 <param name="zip_file" value="faahKO_reduce.zip" ftype="zip" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
63 <output name="log"> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
64 <assert_contents> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
65 <has_text text="object with 4 samples" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
66 <has_text text="Time range: 2506-4484 seconds (41.8-74.7 minutes)" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
67 <has_text text="Mass range: 200.1-600 m/z" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
68 <has_text text="Peaks: 32720 (about 8180 per sample)" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
69 <has_text text="Peak Groups: 8157" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
70 <has_text text="Sample classes: KO, WT" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
71 </assert_contents> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
72 </output> |
| 0 | 73 </test> |
| 74 </tests> | |
| 75 | |
| 1 | 76 <help><![CDATA[ |
| 0 | 77 |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
78 @HELP_AUTHORS@ |
| 0 | 79 |
| 80 ============== | |
| 81 Xcms.fillPeaks | |
| 82 ============== | |
| 83 | |
| 84 ----------- | |
| 85 Description | |
| 86 ----------- | |
| 87 | |
| 88 For each sample, identify peak groups where that sample is not | |
| 89 represented. For each of those peak groups, integrate the signal | |
| 90 in the region of that peak group and create a new peak. | |
| 91 | |
| 92 According to the type of raw-data there are 2 | |
| 93 different methods available. for filling gcms/lcms data the method | |
| 94 "chrom" integrates raw-data in the chromatographic domain, whereas | |
| 95 "MSW" is used for peaklists without retention-time information | |
| 96 like those from direct-infusion spectra. | |
| 97 | |
| 98 | |
| 99 | |
| 100 ----------------- | |
| 101 Workflow position | |
| 102 ----------------- | |
| 103 | |
| 104 | |
| 105 **Upstream tools** | |
| 106 | |
| 107 ========================= ================= ================== ========== | |
| 108 Name output file format parameter | |
| 109 ========================= ================= ================== ========== | |
| 110 xcms.group xset.group.RData rdata.xcms.group RData file | |
| 111 ========================= ================= ================== ========== | |
| 112 | |
| 113 | |
| 114 **Downstream tools** | |
| 115 | |
| 116 +---------------------------+------------------+-----------------------+ | |
| 117 | Name | Output file | Format | | |
| 118 +===========================+==================+=======================+ | |
| 119 |xcms.diffreport | xset.retcor.RData| rdata.xcms.fillpeaks | | |
| 120 +---------------------------+------------------+-----------------------+ | |
| 121 |xcms.annotateDiffreport | xset.retcor.RData| rdata.xcms.fillpeaks | | |
| 122 +---------------------------+------------------+-----------------------+ | |
| 123 | |
| 124 The output file **xset.fillpeaks** is an RData file. You can continue your analysis using it in **xcms.diffreport** or **xcms.annotateDiffreport** tool as an next step of the workflow. | |
| 125 | |
| 126 | |
| 127 **General schema of the metabolomic workflow** | |
| 128 | |
| 129 .. image:: xcms_fillpeaks_workflow.png | |
| 130 | |
| 131 | |
| 132 | |
| 133 ----------- | |
| 134 Input files | |
| 135 ----------- | |
| 136 | |
| 137 +---------------------------+-----------------------+ | |
| 138 | Parameter : num + label | Format | | |
| 139 +===========================+=======================+ | |
| 140 | 1 : RData file | rdata.xcms.group | | |
| 141 +---------------------------+-----------------------+ | |
| 142 | |
| 143 | |
| 144 ---------- | |
| 145 Parameters | |
| 146 ---------- | |
| 147 | |
| 148 | |
| 149 Method | |
| 150 ------ | |
| 151 | |
| 152 **chrom** | |
| 153 | |
| 154 | This method produces intensity values for those missing samples by integrating raw data in peak group region. In a given group, the start and ending retention time points for integration are defined by the median start and end points of the other detected peaks. The start and end m/z values are similarly determined. Intensities can be still be zero, which is a rather unusual intensity for a peak. This is the case if e.g. the raw data was threshholded, and the integration area contains no actual raw intensities, or if one sample is miscalibrated, such the raw data points are (just) outside the integration area. | |
| 155 | Importantly, if retention time correction data is available, the alignment information is used to more precisely integrate the propper region of the raw data. If the corrected retention time is beyond the end of the raw data, the value will be not-a-number (NaN). | |
| 156 | |
| 157 **MSW** | |
| 158 | |
| 159 | "MSW" is used for peaklists without retention-time information like those from direct-infusion spectra. | |
| 160 | |
| 161 ------------ | |
| 162 Output files | |
| 163 ------------ | |
| 164 | |
| 165 xset.fillPeaks.RData : rdata.xcms.fillpeaks format | |
| 166 | |
| 167 | Rdata file that will be used in the **xcms.diffreport** or **xcms.annotateDiffreport** step of the workflow. | |
| 168 | |
| 169 ------ | |
| 170 | |
| 171 .. class:: infomark | |
| 172 | |
| 173 The output file is an group.RData file. You can continue your analysis using it in **xcms.diffreport** or **xcms.annotateDiffreport** tool. | |
| 174 | |
| 175 | |
| 176 --------------------------------------------------- | |
| 177 | |
| 178 --------------- | |
| 179 Working example | |
| 180 --------------- | |
| 181 | |
| 182 Input files | |
| 183 ----------- | |
| 184 | |
| 185 | RData file -> **xset.retcor.RData** | |
| 186 | |
| 187 Parameters | |
| 188 ---------- | |
| 189 | |
| 190 | method -> **chrom** | |
| 191 | |
| 192 | |
| 193 Output files | |
| 194 ------------ | |
| 195 | |
| 196 | **xset.fillPeaks.RData: RData file** | |
| 197 | |
| 198 | |
| 5 | 199 --------------------------------------------------- |
| 200 | |
| 201 Changelog/News | |
| 202 -------------- | |
| 203 | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
204 **Version 2.0.6 - 04/04/2016** |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
205 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
206 - TEST: refactoring to pass planemo test using conda dependencies |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
207 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
208 |
| 5 | 209 **Version 2.0.5 - 10/02/2016** |
| 210 | |
| 211 - BUGFIX: better management of errors. Datasets remained green although the process failed | |
| 212 | |
| 213 - UPDATE: refactoring of internal management of inputs/outputs | |
| 214 | |
| 215 - UPDATE: refactoring to feed the new report tool | |
| 216 | |
| 217 | |
| 218 **Version 2.0.2 - 02/06/2015** | |
| 219 | |
| 220 - 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. | |
| 221 | |
| 222 - IMPROVEMENT: parameter labels have changed to facilitate their reading. | |
| 223 | |
| 224 | |
| 1 | 225 ]]></help> |
| 0 | 226 |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
227 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
228 <expand macro="citation" /> |
| 0 | 229 |
| 230 | |
| 231 </tool> |