Mercurial > repos > lecorguille > xcms_fillpeaks
annotate abims_xcms_fillPeaks.xml @ 15:1c78d61fd646 draft
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
| author | lecorguille |
|---|---|
| date | Mon, 30 Jan 2017 08:52:00 -0500 |
| parents | 1009f0279137 |
| children | 5f61570177e2 |
| rev | line source |
|---|---|
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
1 <tool id="abims_xcms_fillPeaks" name="xcms.fillPeaks" version="2.0.8"> |
| 0 | 2 |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
3 <description>Integrate a sample's signal in regions where peak groups are not represented to create new peaks in missing areas</description> |
| 0 | 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[ |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
13 @COMMAND_XCMS_SCRIPT@ |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
14 xfunction fillPeaks |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
15 image $image |
| 1 | 16 |
| 17 xsetRdataOutput $xsetRData | |
| 18 | |
| 19 method $method | |
| 20 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
21 #if $peaklist.peaklistBool |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
22 variableMetadataOutput $variableMetadata |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
23 dataMatrixOutput $dataMatrix |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
24 convertRTMinute $peaklist.convertRTMinute |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
25 numDigitsMZ $peaklist.numDigitsMZ |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
26 numDigitsRT $peaklist.numDigitsRT |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
27 intval $peaklist.intval |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
28 #end if |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
29 |
|
10
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
30 @COMMAND_ZIPFILE_LOAD@ |
|
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
31 |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
32 @COMMAND_LOG_EXIT@ |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
33 |
| 1 | 34 ]]></command> |
| 0 | 35 |
| 36 <inputs> | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
37 <param name="image" type="data" format="rdata.xcms.group,rdata" label="xset RData file" help="output file from another xcms function (group)" /> |
| 0 | 38 <param name="method" type="select" label="Filling method" help="[method] See the help section below"> |
| 39 <option value="chrom" selected="true">chrom</option> | |
| 40 <option value="MSW" >MSW</option> | |
| 41 </param> | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
42 <conditional name="peaklist"> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
43 <param name="peaklistBool" type="boolean" label="Get a Peak List" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
44 <when value="true"> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
45 <param name="convertRTMinute" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="Convert retention time (seconds) into minutes" help="Convert the columns rtmed, rtmin and rtmax into minutes"/> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
46 <param name="numDigitsMZ" type="integer" value="4" label="Number of decimal places for mass values reported in ions' identifiers." help="A minimum of 4 decimal places is recommended. Useful to avoid duplicates within identifiers" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
47 <param name="numDigitsRT" type="integer" value="0" label="Number of decimal places for retention time values reported in ions' identifiers." help="Useful to avoid duplicates within identifiers" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
48 <param name="intval" type="select" label="Reported intensity values" help="[intval] See the help section below"> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
49 <option value="into" selected="true">into</option> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
50 <option value="maxo">maxo</option> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
51 <option value="intb">intb</option> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
52 </param> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
53 </when> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
54 <when value="false" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
55 </conditional> |
|
10
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
56 <expand macro="zipfile_load"/> |
|
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
57 |
| 0 | 58 </inputs> |
| 59 | |
| 60 <outputs> | |
| 61 <data name="xsetRData" format="rdata.xcms.fillpeaks" label="${image.name[:-6]}.fillPeaks.RData" /> | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
62 <data name="variableMetadata" format="tabular" label="${image.name[:-6]}.fillPeaks.variableMetadata.tsv"> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
63 <filter>(peaklist['peaklistBool'])</filter> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
64 </data> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
65 <data name="dataMatrix" format="tabular" label="${image.name[:-6]}.fillPeaks.dataMatrix.tsv" > |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
66 <filter>(peaklist['peaklistBool'])</filter> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
67 </data> |
| 1 | 68 <data name="log" format="txt" label="xset.log.txt" hidden="true" /> |
| 0 | 69 </outputs> |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
70 |
| 0 | 71 <tests> |
|
9
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
72 <!--<test> |
| 0 | 73 <param name="image" value="xset.group.retcor.group.RData"/> |
| 74 <param name="method" value="chrom"/> | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
75 <param name="zip_file" value="sacuri_dir_root.zip" ftype="zip" /> |
| 1 | 76 <output name="log"> |
| 77 <assert_contents> | |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
78 <has_text text="object with 4 samples" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
79 <has_text text="Time range: 0.2-1140.1 seconds (0-19 minutes)" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
80 <has_text text="Mass range: 50.0021-999.9863 m/z" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
81 <has_text text="Peaks: 199718 (about 49930 per sample)" /> |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
82 <has_text text="Peak Groups: 48958" /> |
| 1 | 83 <has_text text="Sample classes: bio, blank" /> |
| 84 </assert_contents> | |
| 85 </output> | |
|
9
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
86 </test>--> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
87 <test> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
88 <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
|
89 <param name="method" value="chrom"/> |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
90 <conditional name="peaklist"> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
91 <param name="convertRTMinute" value="false" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
92 <param name="peaklistBool" value="true" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
93 <param name="numDigitsMZ" value="4" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
94 <param name="numDigitsRT" value="1" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
95 </conditional> |
|
10
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
96 <param name="zipfile_load_conditional|zipfile_load_select" value="yes" /> |
|
35269602a971
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 960f403303e1691bdd6137c46895feb333b36a82
lecorguille
parents:
9
diff
changeset
|
97 <param name="zipfile_load_conditional|zip_file" value="faahKO_reduce.zip" ftype="zip" /> |
|
9
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
98 <output name="log"> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
99 <assert_contents> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
100 <has_text text="object with 4 samples" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
101 <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
|
102 <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
|
103 <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
|
104 <has_text text="Peak Groups: 8157" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
105 <has_text text="Sample classes: KO, WT" /> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
106 </assert_contents> |
|
46f62282c8d8
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 727b4a74b8e424af622dc0e2b0c910cdd020cd29
lecorguille
parents:
6
diff
changeset
|
107 </output> |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
108 <output name="variableMetadata" file="faahKO.xset.group.retcor.group.fillPeaks.variableMetadata.tsv" /> |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
109 <output name="dataMatrix" file="faahKO.xset.group.retcor.group.fillPeaks.dataMatrix.tsv" /> |
| 0 | 110 </test> |
| 111 </tests> | |
| 112 | |
| 1 | 113 <help><![CDATA[ |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
114 |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
115 @HELP_AUTHORS@ |
| 0 | 116 |
| 117 ============== | |
| 118 Xcms.fillPeaks | |
| 119 ============== | |
| 120 | |
| 121 ----------- | |
| 122 Description | |
| 123 ----------- | |
| 124 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
125 **Integrate areas of missing peaks** |
| 0 | 126 For each sample, identify peak groups where that sample is not |
| 127 represented. For each of those peak groups, integrate the signal | |
| 128 in the region of that peak group and create a new peak. | |
| 129 | |
| 130 According to the type of raw-data there are 2 | |
| 131 different methods available. for filling gcms/lcms data the method | |
| 132 "chrom" integrates raw-data in the chromatographic domain, whereas | |
| 133 "MSW" is used for peaklists without retention-time information | |
| 134 like those from direct-infusion spectra. | |
| 135 | |
| 136 | |
| 137 | |
| 138 ----------------- | |
| 139 Workflow position | |
| 140 ----------------- | |
| 141 | |
| 142 | |
| 143 **Upstream tools** | |
| 144 | |
| 145 ========================= ================= ================== ========== | |
| 146 Name output file format parameter | |
| 147 ========================= ================= ================== ========== | |
| 148 xcms.group xset.group.RData rdata.xcms.group RData file | |
| 149 ========================= ================= ================== ========== | |
| 150 | |
| 151 | |
| 152 **Downstream tools** | |
| 153 | |
| 154 +---------------------------+------------------+-----------------------+ | |
| 155 | Name | Output file | Format | | |
| 156 +===========================+==================+=======================+ | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
157 |CAMERA.annotate | xset.retcor.RData| rdata.xcms.fillpeaks | |
| 0 | 158 +---------------------------+------------------+-----------------------+ |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
159 |xcms.summary | xset.retcor.RData| rdata.xcms.fillpeaks | |
| 0 | 160 +---------------------------+------------------+-----------------------+ |
| 161 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
162 The output file **xset.fillpeaks** is a RData file. You can continue your analysis using it in **CAMERA.annotate** or **xcms.summary** tool as a following step of your workflow. |
| 0 | 163 |
| 164 | |
| 165 **General schema of the metabolomic workflow** | |
| 166 | |
| 167 .. image:: xcms_fillpeaks_workflow.png | |
| 168 | |
| 169 | |
| 170 | |
| 171 ----------- | |
| 172 Input files | |
| 173 ----------- | |
| 174 | |
| 175 +---------------------------+-----------------------+ | |
| 176 | Parameter : num + label | Format | | |
| 177 +===========================+=======================+ | |
| 178 | 1 : RData file | rdata.xcms.group | | |
| 179 +---------------------------+-----------------------+ | |
| 180 | |
| 181 | |
| 182 ---------- | |
| 183 Parameters | |
| 184 ---------- | |
| 185 | |
| 186 | |
| 187 Method | |
| 188 ------ | |
| 189 | |
| 190 **chrom** | |
| 191 | |
| 192 | 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. | |
| 193 | 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). | |
| 194 | |
| 195 **MSW** | |
| 196 | |
| 197 | "MSW" is used for peaklists without retention-time information like those from direct-infusion spectra. | |
| 198 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
199 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
200 Get a Peak List |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
201 --------------- |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
202 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
203 If 'true', the module generates two additional files corresponding to the peak list: |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
204 - the variable metadata file (corresponding to information about extracted ions such as mass or retention time) |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
205 - the data matrix (corresponding to related intensities) |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
206 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
207 **decimal places for [mass or retention time] values in identifiers** |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
208 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
209 | Ions' identifiers are constructed as MxxxTyyy where 'xxx' is the ion median mass and 'yyy' the ion median retention time. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
210 | Two parameters are used to adjust the number of decimal places wanted in identifiers for mass and retention time respectively. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
211 | Theses parameters do not affect decimal places in columns other than the identifier one. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
212 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
213 **Reported intensity values** |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
214 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
215 | This parameter determines which values should be reported as intensities in the dataMatrix table; it correspond to xcms 'intval' parameter: |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
216 | - into: integrated area of original (raw) peak |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
217 | - maxo: maximum intensity of original (raw) peak |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
218 | - intb: baseline corrected integrated peak area (only available if peak detection was done by ‘findPeaks.centWave’) |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
219 |
| 0 | 220 ------------ |
| 221 Output files | |
| 222 ------------ | |
| 223 | |
| 224 xset.fillPeaks.RData : rdata.xcms.fillpeaks format | |
| 225 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
226 | Rdata file that will be used in the **CAMERA.annotate** or **xcms.summary** step of the workflow. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
227 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
228 xset.variableMetadata.tsv : tabular format |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
229 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
230 | Table containing information about ions; can be used as one input of **Quality_Metrics** or **Generic_filter* modules. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
231 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
232 xset.dataMatrix.tsv : tabular format |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
233 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
234 | Table containing ions' intensities; can be used as one input of **Quality_Metrics** or **Generic_filter* modules. |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
235 |
| 0 | 236 ------ |
| 237 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
238 .. class:: infomark |
| 0 | 239 |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
240 The output file is a xset.fillPeaks.RData file. You can continue your analysis using it in **CAMERA.annotate** or **xcms.summary** tool. |
| 0 | 241 |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
242 |
| 0 | 243 --------------------------------------------------- |
| 244 | |
| 245 --------------- | |
| 246 Working example | |
| 247 --------------- | |
| 248 | |
| 249 Input files | |
| 250 ----------- | |
| 251 | |
| 252 | RData file -> **xset.retcor.RData** | |
| 253 | |
| 254 Parameters | |
| 255 ---------- | |
| 256 | |
| 257 | method -> **chrom** | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
258 | Get a Peak List -> **false** |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
259 |
| 0 | 260 |
| 261 Output files | |
| 262 ------------ | |
| 263 | |
| 264 | **xset.fillPeaks.RData: RData file** | |
| 265 | |
| 266 | |
| 5 | 267 --------------------------------------------------- |
| 268 | |
| 269 Changelog/News | |
| 270 -------------- | |
| 271 | |
|
15
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
272 **Version 2.0.8 - 22/12/2016** |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
273 |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
274 - IMPROVEMENT: Add an option to export the peak list at this step without having to wait for CAMERA.annotate |
|
1c78d61fd646
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 08e7f269a5c59687a7768be8db5fcb4e4d736093
lecorguille
parents:
12
diff
changeset
|
275 |
|
12
1009f0279137
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
276 **Version 2.0.7 - 06/07/2016** |
|
1009f0279137
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
277 |
|
1009f0279137
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
278 - UPGRADE: upgrate the xcms version from 1.44.0 to 1.46.0 |
|
1009f0279137
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit ec6f0c17bb277ea34f898d96d12d3357220f73d4
lecorguille
parents:
10
diff
changeset
|
279 |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
280 **Version 2.0.6 - 04/04/2016** |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
281 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
282 - TEST: refactoring to pass planemo test using conda dependencies |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
283 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
284 |
| 5 | 285 **Version 2.0.5 - 10/02/2016** |
| 286 | |
| 287 - BUGFIX: better management of errors. Datasets remained green although the process failed | |
| 288 | |
| 289 - UPDATE: refactoring of internal management of inputs/outputs | |
| 290 | |
| 291 - UPDATE: refactoring to feed the new report tool | |
| 292 | |
| 293 | |
| 294 **Version 2.0.2 - 02/06/2015** | |
| 295 | |
| 296 - 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. | |
| 297 | |
| 298 - IMPROVEMENT: parameter labels have changed to facilitate their reading. | |
| 299 | |
| 300 | |
| 1 | 301 ]]></help> |
| 0 | 302 |
|
6
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
303 |
|
f00e39a4b0fb
planemo upload commit a3229faad6949bbca965d1d7e138cb3c0550780e
lecorguille
parents:
5
diff
changeset
|
304 <expand macro="citation" /> |
| 0 | 305 |
| 306 | |
| 307 </tool> |
