Mercurial > repos > lecorguille > xcms_merge

annotate xcms_merge.xml @ 8:a26679f68d4d draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
author lecorguille
date Mon, 11 Feb 2019 05:58:26 -0500
parents f439ed7a8f03
children e3fccadf32a8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
1 <tool id="xcms_merge" name="xcms findChromPeaks Merger" version="@WRAPPER_VERSION@.0">
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
2 <description>Merge xcms findChromPeaks RData into a unique file to be used by group</description>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
3
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
4 <macros>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
5 <import>macros.xml</import>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
6 <import>macros_xcms.xml</import>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
7 </macros>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
8
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
9 <expand macro="requirements"/>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
10 <expand macro="stdio"/>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
11
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
12 <command><![CDATA[
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
13 @COMMAND_RSCRIPT@/xcms_merge.r
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
14
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
15 images 'c("${"\",\"".join(map(str, $images))}")'
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
16
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
17 #if str($sampleMetadata) != 'None':
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
18 sampleMetadata '$sampleMetadata'
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
19 #end if
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
20
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
21 @COMMAND_FILE_LOAD@
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
22 ]]></command>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
23
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
24 <inputs>
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
25 <param name="images" type="data" format="rdata.xcms.findchrompeaks,rdata" label="@INPUT_IMAGE_LABEL@" help="@INPUT_IMAGE_HELP@ from multiple findChromPeaks" multiple="true" />
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
26 <param name="sampleMetadata" label="Sample metadata file " format="tabular" type="data" optional="true" help="must contain at least one column with the sample id and one column with the sample class"/>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
27
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
28 <expand macro="input_file_load"/>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
29 </inputs>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
30
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
31 <outputs>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
32 <data name="xsetRData" format="rdata.xcms.findchrompeaks" label="xset.merged.RData" from_work_dir="merged.RData" />
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
33 <data name="sampleMetadataOutput" format="tabular" label="xset.merged.sampleMetadata.tsv" from_work_dir="sampleMetadata.tsv">
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
34 <filter>not sampleMetadata</filter>
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
35 </data>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
36 </outputs>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
37
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
38 <tests>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
39 <!-- DISABLE FOR TRAVIS
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
40 <test>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
41 <param name="images" value="ko15-xset.RData,ko16-xset.RData,wt15-xset.RData,wt16-xset.RData" ftype="rdata"/>
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
42 <expand macro="test_file_load_single"/>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
43 <assert_stdout>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
44 <has_text text="object with 4 samples" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
45 <has_text text="Time range: 2506.1-4477.9 seconds (41.8-74.6 minutes)" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
46 <has_text text="Mass range: 200.1-600 m/z" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
47 <has_text text="Peaks: 9251 (about 2313 per sample)" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
48 <has_text text="Peak Groups: 0" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
49 <has_text text="Sample classes: ." />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
50 </assert_stdout>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
51 <output name="sampleMetadataOutput" file="noclass.merged.sampleMetadata.tsv" />
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
52 </test>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
53 -->
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
54 <test>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
55 <param name="images" value="ko15-xset.RData,ko16-xset.RData,wt15-xset.RData,wt16-xset.RData" ftype="rdata"/>
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
56 <expand macro="test_file_load_single"/>
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
57 <param name="sampleMetadata" value="sampleMetadata.tab" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
58 <assert_stdout>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
59 <has_text_matching expression="ko15\s+KO" />
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
60 <has_text_matching expression="ko16\s+KO" />
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
61 <has_text_matching expression="wt15\s+WT" />
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
62 <has_text_matching expression="wt16\s+WT" />
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
63 <has_text text="object with 4 samples" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
64 <has_text text="Time range: 2506.1-4477.9 seconds (41.8-74.6 minutes)" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
65 <has_text text="Mass range: 200.1-600 m/z" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
66 <has_text text="Peaks: 9251 (about 2313 per sample)" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
67 <has_text text="Peak Groups: 0" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
68 <has_text text="Sample classes: KO, WT" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
69 </assert_stdout>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
70 </test>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
71 <!--<test expect_failure="True">
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
72 <param name="images" value="ko15-xset.RData,ko16-xset.RData,wt15-xset.RData,wt16-xset.RData" ftype="rdata"/>
2
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
73 <param name="sampleMetadata" value="sampleMetadata_missing.tab" />
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
74 <expand macro="test_file_load_single"/>
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
75 <assert_stderr>
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
76 <has_text text="Those samples are missing in your sampleMetadata: ko16" />
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
77 </assert_stderr>
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
78 </test>-->
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
79 </tests>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
80
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
81 <help><![CDATA[
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
82
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
83 @HELP_AUTHORS@
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
84
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
85 ==========================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
86 xcms findChromPeaks Merger
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
87 ==========================
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
88
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
89 -----------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
90 Description
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
91 -----------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
92
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
93 This tool allows you to run one xcms findChromPeaks process per sample in parallel and then to merge all RData images into one.
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
94 The result is then suitable for xcms groupChromPeaks.
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
95
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
96 You can provide a sampleMetadata table to attribute phenotypic values to your samples.
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
97
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
98
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
99 -----------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
100 Workflow position
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
101 -----------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
102
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
103 **Upstream tools**
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
104
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
105 ========================= ===================== ==============================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
106 Name Output file Format
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
107 ========================= ===================== ==============================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
108 xcms.findChromPeaks ``*``.raw.xset.RData rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
109 ------------------------- --------------------- ------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
110 xcms.findChromPeaks ``*``.raw.xset.RData rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
111 ------------------------- --------------------- ------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
112 xcms.findChromPeaks ``*``.raw.xset.RData rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
113 ------------------------- --------------------- ------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
114 ... ... ...
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
115 ------------------------- --------------------- ------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
116 Upload file [optional] sampleMetadata tabular
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
117 ========================= ===================== ==============================
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
118
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
119
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
120 **Downstream tools**
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
121
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
122 =========================== ==================== ============================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
123 Name Output file Format
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
124 =========================== ==================== ============================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
125 xcms.groupChromPeaks xset.merged.RData rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
126 =========================== ==================== ============================
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
127
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
128 .. image:: xcms_merge_workflow.png
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
129
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
130 -----------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
131 Input files
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
132 -----------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
133
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
134 =========================== ==================================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
135 Parameter : num + label Format
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
136 =========================== ==================================
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
137 1 : RData file rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
138 --------------------------- ----------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
139 2 : RData file rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
140 --------------------------- ----------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
141 N : RData file rdata.xcms.findchrompeaks
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
142 --------------------------- ----------------------------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
143 Optional : sampleMetadata tsv or csv
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
144 =========================== ==================================
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
145
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
146 Example of a sampleMetadata:
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
147
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
148 =========================== ============
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
149 Samples class
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
150 =========================== ============
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
151 HU_neg_028 bio
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
152 --------------------------- ------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
153 HU_neg_034 bio
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
154 --------------------------- ------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
155 Blanc04 blank
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
156 --------------------------- ------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
157 Blanc06 blank
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
158 --------------------------- ------------
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
159 Blanc09 blank
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
160 =========================== ============
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
161
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
162
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
163 ------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
164 Output files
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
165 ------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
166
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
167 xset.merged.RData: rdata.xcms.findchrompeaks format
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
168
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
169 | Rdata file that is necessary in the next step of the workflow "xcms.groupChromPeaks".
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
170
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
171 ---------------------------------------------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
172
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
173 Changelog/News
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
174 --------------
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
175
8
a26679f68d4d planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 3
diff changeset
176 **Version 3.4.3.0 - 08/02/2019**
a26679f68d4d planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 3
diff changeset
177
a26679f68d4d planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 3
diff changeset
178 - UPGRADE: upgrade the xcms version from 3.0.0 to 3.4.3
a26679f68d4d planemo upload for repository https://github.com/workflow4metabolomics/xcms commit f0d42bca2f34c58c04b55e5990058d479c0ae639
lecorguille
parents: 3
diff changeset
179
3
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
180 **Version 3.0.0.0 - 08/03/2018**
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
181
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
182 - UPGRADE: upgrade the xcms version from 1.46.0 to 3.0.0. So refactoring of a lot of underlining codes and methods
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
183
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
184 - IMPROVMENT: a new dedicated tool "xcms plot chromatogram" will allow you to get TIC and BPI of your raw data.
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
185
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
186 - IMPROVMENT: the tool will now generate a sampleMetadata file if any was provided. It will be useful to add some further information for the normalization and statistics steps.
f439ed7a8f03 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 9f72e947d9c241d11221cad561f3525d27231857
lecorguille
parents: 2
diff changeset
187
2
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
188 **Version 1.0.1 - 13/02/2017**
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
189
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
190 - IMPROVMENT: the tool will now raise an error if a sample isn't describe in the sampleMetadata file
3a5204f14fff planemo upload for repository https://github.com/workflow4metabolomics/xcms commit 73791d74546087b2a872d9279df960f5bc207298
lecorguille
parents: 0
diff changeset
191
0
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
192 **Version 1.0.0 - 03/02/2017**
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
193
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
194 - NEW: a new tool to merge individual xcmsSet outputs to be used by xcms.group
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
195
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
196 ]]></help>
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
197
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
198 <expand macro="citation" />
47f9b1fd5ce6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit a6f5f18b3d6130f7d7fbb9f2df856838c6217797
lecorguille
parents:
diff changeset
199 </tool>