annotate ipo4retgroup.xml @ 10:57f180a8eaae draft default tip

planemo upload for repository https://github.com/rietho/IPO commit d25c744220e416cce158161fa7dc3b0f153a5c11
author workflow4metabolomics
date Mon, 11 Sep 2023 22:36:51 +0000
parents 364756ea5f42
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
1 <tool id="ipo4retgroup" name="IPO for group and retcor" version="@TOOL_VERSION@+galaxy0">
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
2
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
3 <description>IPO optimization process for xcms.groupChromPeaks and xcms.adjustRtime</description>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
4
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
5 <macros>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
6 <import>macros.xml</import>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
7 </macros>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
8
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
9 <expand macro="requirements"/>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
10
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
12 LANG=C Rscript '$__tool_directory__/ipo4retgroup.r'
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
13
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
14 image '$image'
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
15
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
16 parametersOutput '$parametersOutput'
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
17
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
18 samplebyclass $samplebyclass
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
19
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
20 @COMMAND_NSLAVES@
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
21
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
22 ## group methods
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
23
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
24 sleep 0.001
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
25 #if $group.method == "density":
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
26 bw "c($group.section_group_density_optiomizable.bw)"
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
27 mzwid "c($group.section_group_density_optiomizable.mzwid)"
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
28
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
29 minfrac $group.section_group_density_non_optimizable.minfrac
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
30 max $group.section_group_density_non_optimizable.max
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
31 #end if
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
32
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
33 ## retcor methods
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
34
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
35 #if $retcor.methods.method == "obiwarp":
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
36 retcorMethod obiwarp
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
37 profStep $retcor.methods.section_retcor_obiwarp_non_optimizable.profStep
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
38
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
39 #elif $retcor.methods.method == "peakgroups":
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
40 retcorMethod loess
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
41 smooth $retcor.methods.section_retcor_peakgroups_non_optimizable.smooth
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
42 extra $retcor.methods.section_retcor_peakgroups_non_optimizable.extra
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
43 missing $retcor.methods.section_retcor_peakgroups_non_optimizable.missing
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
44 span $retcor.methods.section_retcor_peakgroups_non_optimizable.span
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
45 family $retcor.methods.section_retcor_peakgroups_non_optimizable.family
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
46 plottype $retcor.methods.section_retcor_peakgroups_non_optimizable.plottype
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
47 #elif $retcor.methods.method == "none":
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
48 retcorMethod none
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
49 #end if
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
50
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
51 @COMMAND_FILE_LOAD@
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
52 ]]></command>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
53
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
54 <inputs>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
55
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
56 <param name="image" type="data" format="rdata.xcms.raw,rdata.xcms.group,rdata.xcms.retcor,rdata" label="xset RData file" help="output file from another function xcms (xcmsSet, retcor etc.)" />
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
57
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
58 <param name="samplebyclass" type="integer" value="2" min="0" label="Number of samples used per class to estimate the best parameters" help="Set to 0 to use the whole dataset. To save time, reduce this number" />
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
59
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
60 <section name="group" title="groupChromPeaks Options" expanded="True">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
61 <param argument="method" type="select" label="Method to use for grouping" help="See the help section below. Only the density method is available so far">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
62 <option value="density" selected="true">density</option>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
63 </param>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
64 <section name="section_group_density_optiomizable" title="Optimizable parameters" expanded="True">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
65 <param argument="bw" type="text" value="22,38" label="Range or a fixed value for Bandwidth" help="bandwidth (standard deviation or half width at half maximum) of gaussian smoothing kernel to apply to the peak density chromatogram (ex: 22,38)">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
66 <expand macro="input_validator_range_integer"/>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
67 </param>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
68 <param argument="mzwid" type="text" value="0.015,0.035" label="Range or a fixed value for Width of overlapping m/z slices" help="to use for creating peak density chromatograms and grouping peaks across samples (ex: 0.015,0.035)" >
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
69 <expand macro="input_validator_range_float_neg"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
70 </param>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
71 </section>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
72 <section name="section_group_density_non_optimizable" title="Non optimizable parameters" expanded="True">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
73 <param argument="minfrac" type="float" value="0.5" label="Minimum fraction of samples necessary" help="in at least one of the sample groups for it to be a valid group" />
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
74 <param argument="max" type="integer" value="50" label="Maximum number of groups to identify in a single m/z slice" />
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
75 </section>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
76 </section>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
77
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
78 <section name="retcor" title="adjustRtime Options" expanded="True">
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
79 <conditional name="methods">
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
80 <param argument="method" type="select" label="Method to use for retention time correction" help="See the help section below" >
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
81 <option value="obiwarp">obiwarp</option>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
82 <option value="peakgroups">peakgroups</option>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
83 </param>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
84 <when value="obiwarp">
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
85 <section name="section_retcor_obiwarp_non_optimizable" title="Non optimizable parameters" expanded="True">
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
86 <param argument="profStep" type="text" value="0.7,1.0" label="Range or a fixed value for Step size (in m/z)" help="to use for profile generation from the raw data files (ex: 1 or 0.7 1.0)" >
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
87 <expand macro="input_validator_range_float_neg"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
88 </param>
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
89 </section>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
90 </when>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
91 <when value="peakgroups">
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
92 <section name="section_retcor_peakgroups_non_optimizable" title="Non optimizable parameters" expanded="True">
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
93 <param argument="smooth" type="select" label="Smooth method" help="only the 'loess’ for non-linear alignment is available so far" >
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
94 <option value="loess">loess</option>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
95 </param>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
96 <param argument="extra" type="integer" value="1" min="0" label="Number of extra peaks to allow in retention time correction correction groups" />
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
97 <param argument="missing" type="integer" value="1" min="0" label="Number of missing samples to allow in retention time correction groups" />
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
98 <param argument="span" type="float" value="0.2" min="0" label="Degree of smoothing for local polynomial regression fitting" />
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
99 <param argument="family" type="select" label="Family" help="if gaussian fitting is by least-squares with no outlier removal, and if symmetric a re descending M estimator is used with Tukey's biweight function, allowing outlier removal">
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
100 <option value="gaussian" selected="true">gaussian</option>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
101 <option value="symmetric">symmetric</option>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
102 </param>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
103 <param argument="plottype" type="select" help="if deviation plot retention time deviation points and regression fit, and if mdevden also plot peak overall peak density and retention time correction peak density">
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
104 <option value="none" selected="true">none</option>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
105 <option value="deviation">deviation</option>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
106 <option value="mdevden">mdevden</option>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
107 </param>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
108 </section>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
109 </when>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
110 </conditional>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
111
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
112 </section>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
113
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
114 <expand macro="input_file_load"/>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
115
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
116 </inputs>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
117
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
118 <outputs>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
119 <data name="parametersOutput" format="tabular" label="IPO_parameters4xcmsSet.tsv" from_work_dir="IPO_parameters4xcmsSet.tsv"/>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
120 </outputs>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
121
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
122 <tests>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
123 <test>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
124 <param name="image" value="faahKO.xset_single.RData"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
125 <param name="samplebyclass" value="0"/>
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
126 <section name="group">
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
127 <param name="method" value="density"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
128 <section name="section_group_density_optiomizable">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
129 <param name="bw" value="5,6"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
130 <param name="mzwid" value="0.01,0.02"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
131 </section>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
132 <section name="section_group_density_non_optimizable">
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
133 <param name="minfrac" value="1"/>
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
134 </section>
7
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
135 </section>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
136 <section name="retcor">
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
137 <conditional name="methods">
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
138 <param name="method" value="peakgroups"/>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
139 <section name="section_retcor_peakgroups_non_optimizable">
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
140 <param name="smooth" value="loess"/>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
141 <param name="rextra" value="1"/>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
142 <param name="missing" value="1"/>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
143 </section>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
144 </conditional>
dd0a593dded1 planemo upload commit c3ffcc9ea76a0e143e11613e6841ee59a28578fd
lecorguille
parents: 6
diff changeset
145 </section>
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
146 <expand macro="test_file_load_single"/>
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
147 <output name="parametersOutput" file="faahKO_IPO_parameters4retgroup_bw.tsv" />
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
148 </test>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
149 </tests>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
150
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
151 <help><![CDATA[
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
152
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
153 @HELP_AUTHORS@
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
154
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
155 ===============
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
156 IPO.ipo4xcmsSet
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
157 ===============
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
158
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
159 -----------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
160 Description
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
161 -----------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
162
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
163 A Tool for automated Optimization of XCMS Parameters
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
164
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
165
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
166 -----------------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
167 Workflow position
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
168 -----------------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
169
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
170 **Upstream tools**
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
171
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
172 ==================================== ======================== ==============================
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
173 Name Output file Format
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
174 ==================================== ======================== ==============================
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
175 xcms.findChromPeaks Merger (single) xset.merged.RData rdata.xcms.findchrompeaks
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
176 ------------------------------------ ------------------------ ------------------------------
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
177 xcms.adjustRtime ``*``.adjustRtime.RData rdata.xcms.retcor
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
178 ==================================== ======================== ==============================
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
179
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
180
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
181 **Downstream tools**
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
182
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
183 +---------------------------+----------------------+-----------------+
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
184 | Name | Output file | Format |
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
185 +===========================+======================+=================+
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
186 |xcms.groupChromPeaks | parametersOutput.tsv | Tabular |
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
187 +---------------------------+--------------------+-------------------+
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
188
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
189
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
190 ----------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
191 Parameters
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
192 ----------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
193
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
194 Method to use for groupChromPeaks
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
195 ---------------------------------
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
196
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
197 **PeakDensity**
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
198
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
199 | This method performs performs correspondence (chromatographic peak grouping) based on the density (distribution) of identified peaks along the retention time axis within slices of overlapping mz ranges. All peaks (from the same or from different samples) being close on the retention time axis are grouped into a feature (peak group).
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
200 | See the PeakDensity_manual_
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
201
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
202
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
203 .. _PeakDensity_manual: https://rdrr.io/bioc/xcms/man/groupChromPeaks-density.html#heading-2
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
204
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
205
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
206 Method to use for adjustRtime
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
207 -------------------------------------------
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
208
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
209 **PeakGroups**
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
210
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
211 | This method performs retention time adjustment based on the alignment of chromatographic peak groups present in all/most samples (hence corresponding to house keeping compounds). First the retention time deviation of these peak groups is described by fitting either a polynomial (‘smooth = "loess"’) or a linear ( ‘smooth = "linear"’) model to the data points. These models are subsequently used to adjust the retention time of each spectrum in each sample.
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
212 | See the PeakGroups_manual_
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
213
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
214 **Obiwarp**
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
215
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
216 | This method performs retention time adjustment using the Obiwarp method [Prince 2006]. It is based on the code at http://obi-warp.sourceforge.net but supports alignment of multiple samples by aligning each against a _center_ sample. The alignment is performed directly on the ‘profile-matrix’ and can hence be performed independently of the peak detection or peak grouping.
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
217 | See the Obiwarp_manual_
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
218
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
219 .. _PeakGroups_manual: https://rdrr.io/bioc/xcms/man/adjustRtime-peakGroups.html#heading-2
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
220 .. _Obiwarp_manual: https://rdrr.io/bioc/xcms/man/adjustRtime-obiwarp.html
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
221
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
222 ---------------------------------------------------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
223
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
224 Changelog/News
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
225 --------------
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
226
9
364756ea5f42 "planemo upload for repository https://github.com/rietho/IPO commit 5083f3b5800bdd8515519f2f6398046b41e1df97"
workflow4metabolomics
parents: 7
diff changeset
227 @HELP_NEWVERSION_1_10_0_0@
6
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
228
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
229 ]]></help>
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
230
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
231 <expand macro="citation" />
03fdfbd914ab planemo upload commit 8dfb0b11442ccce78165b5d8f07555ccbd303cce
lecorguille
parents:
diff changeset
232 </tool>