Mercurial > repos > workflow4metabolomics > camera_groupfwhm

comparison groupFWHM.xml @ 0:6aea0427511e draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 24d44ee26b7c23380c2b42fae2f7f6e58472100d
author workflow4metabolomics
date Sun, 24 Nov 2024 21:28:57 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:6aea0427511e
1 <tool id="CAMERA_groupFWHM" name="CAMERA.groupFWHM" version="0.1.0+camera@TOOL_VERSION@-galaxy@VERSION_SUFFIX@" profile="23.0">
2
3 <description>Group peaks into pseudospectra-groups</description>
4
5 <macros>
6 <import>macros.xml</import>
7 </macros>
8
9 <expand macro="requirements"/>
10
11 <required_files>
12 <include type="literal" path="CAMERA_groupFWHM.R"/>
13 <include type="literal" path="lib.r"/>
14 </required_files>
15
16 <command detect_errors="exit_code"><![CDATA[
17 @COMMAND_RSCRIPT@CAMERA_groupFWHM.R
18 image '$image'
19 sigma $sigma
20 perfwhm $perfwhm
21 intval $intval
22 polarity $polarity
23 convertRTMinute $convertRTMinute
24 numDigitsMZ $numDigitsMZ
25 numDigitsRT $numDigitsRT
26
27 #if $advenced.advenced_select == "FALSE":
28 sample NA
29 nSlaves 1
30 #else
31 sample $sample
32 nSlaves 1
33 #end if
34
35 @COMMAND_FILE_LOAD@
36 ]]>
37 </command>
38
39 <inputs>
40 <param name="image" type="data" label="RData file" format="rdata" help="output file from another function xcms (fillPeaks)" />
41 <param name="sigma" type="integer" value="6" label="the multiplier of the standard deviation"/>
42 <param name="perfwhm" type="float" value="0.6" max="1" min="0" label="percentage of the width of the FWHM"/>
43 <param name="intval" type="select" label="intensity values for ordering. Allowed values are into, maxo, intb">
44 <option value="into" selected="true">into</option>
45 <option value="maxo">maxo</option>
46 <option value="intb">intb</option>
47 </param>
48 <param name="polarity" type="select" label="polarity">
49 <option value="positive" selected="true">Positive</option>
50 <option value="negative">Negative</option>
51 </param>
52 <conditional name="advenced">
53 <param name="advenced_select" type="select" label="Advanced parameters">
54 <option value="TRUE">TRUE</option>
55 <option value="FALSE" selected="true">FALSE</option>
56 </param>
57 <when value="FALSE">
58 <!--<param name="sample" type="text" value="NA" label="use all the samples (automatic selection)" optional="true" />-->
59 <!--<param name="nSlaves" type="integer" value="1" label="For parallel mode set nSlaves higher than 1" optional="true" />-->
60 </when>
61 <when value="TRUE">
62 <param name="sample" type="text" value="NA" label="use all the samples (automatic selection)" optional="true" />
63 <!-- issue with findAdducts Use of 'xcmsClusterApply' is deprecated! Use 'BPPARAM' arguments instead. Need update of the package -->
64 <!-- <param name="nSlaves" type="integer" value="1" max="3" min="1" label="for parallel mode set nSlaves higher than 1" optional="true" /> -->
65 </when>
66 </conditional>
67 <param name="convertRTMinute" type="boolean" checked="false" truevalue="TRUE" falsevalue="FALSE" label="Convert seconds to minutes when exporting tsv" />
68 <param name="numDigitsMZ" type="integer" value="4" max="4" min="0" label="Number of digits for MZ values (namecustom)" />
69 <param name="numDigitsRT" type="integer" value="4" max="4" min="0" label="Number of digits for RT values (namecustom)" />
70 <expand macro="input_file_load"/>
71 </inputs>
72
73 <outputs>
74 <data name="variableMetadata" format="tabular" label="${image.name[:-6]}.fwhm.variableMetadata.tsv" from_work_dir="variableMetadata.tsv" />
75 <data name="camera_fwhm_rdata" format="rdata" label="${image.name[:-6]}.fwhm.RData" from_work_dir="camera_fwhm.RData"/>
76 </outputs>
77
78 <tests>
79 <test expect_num_outputs="2">
80 <param name="image" value="xset.merged.group.retcor.group.fillPeaks.RData" />
81 <!--<param name="sigma" value="6" />
82 <param name="perfwhm" value="0.6" />
83 <param name="intval" value="into" />-->
84 <expand macro="test_file_load_faahKO_15"/>
85 <output name="variableMetadata" file="xset.merged.group.retcor.group.fillPeaks.fwhm.variableMetadata.tsv" />
86 <output name="camera_fwhm_rdata" value="xset.merged.group.retcor.group.fillPeaks.fwhm.RData" compare="sim_size" delta="5000" />
87 </test>
88 </tests>
89 <help><![CDATA[
90
91 ================
92 CAMERA.groupFWHM
93 ================
94
95 -----------
96 Description
97 -----------
98
99 .. _link: https://bioconductor.org/packages/release/bioc/manuals/CAMERA/man/CAMERA.pdf
100
101 Group peaks of a xsAnnotate object according to their retention time into pseudospectra-groups.
102 Uses the peak FWHMs as grouping borders. Returns xsAnnotate object with pseudospectra informations.
103
104 ---------------------------------------------------
105
106 ---------
107 Arguments
108 ---------
109
110 +--------------+-------------------------------------------------------------------+
111 |Variables |Descriptions |
112 +==============+===================================================================+
113 |object |the xsAnnotate object |
114 +--------------+-------------------------------------------------------------------+
115 |sigma |the multiplier of the standard deviation |
116 +--------------+-------------------------------------------------------------------+
117 |perfwhm |percentage of the width of the FWHM |
118 +--------------+-------------------------------------------------------------------+
119 |intval |intensity values for ordering. Allowed values are into, maxo, intb |
120 +--------------+-------------------------------------------------------------------+
121
122 ---------------------------------------------------
123
124 -------
125 Details
126 -------
127
128 Every peak that shares a retention time with a selected peak will be part of the group. Same timepoint is defined about the Rt_med +/- FWHM * perfwhm. For a single sample xcmsSet, the selection of peaks starts at the most abundant and goes down to the least abundant. With a multiple sample set, the automatic selection uses the most abundant peak as an representative for every feature group, according to the xcms grouping. The FWHM (full width at half maximum) of a peak is estimated as FWHM = SD * 2.35. For the calculation of the SD, the peak is assumed as normal distributed.
129
130 ---------------------------------------------------
131
132 ------------------------------------------
133 General schema of the metabolomic workflow
134 ------------------------------------------
135
136 .. image:: groupFWHM.png
137
138 ---------------------------------------------------
139
140 --------------
141 Changelog/News
142 --------------
143
144 .. _News: https://bioconductor.org/packages/release/bioc/news/CAMERA/NEWS
145
146 @HELP_CAMERA_SUITE@
147
148 ]]> </help>
149
150 <expand macro="citation"/>
151 <expand macro="creator"/>
152 </tool>