annotate xcms_merge.xml @ 22:83c00880b7c8 draft

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