annotate xcms_plot_eic.xml @ 0:51015f22fcb7 draft default tip

planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
author workflow4metabolomics
date Mon, 15 Jul 2024 16:03:37 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
1 <tool id="xcms_plot_eic" name="xcms plot eic" version="@TOOL_VERSION@+galaxy0" profile="21.09">
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
2 <description>Plot the extracted ion chromatogram (EIC) from mzML file</description>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
3 <macros>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
4 <import>macros_xcms_plot.xml</import>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
5 </macros>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
6 <expand macro="bio.tools"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
7 <expand macro="creator"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
8 <requirements>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">bioconductor-xcms</requirement>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
10 </requirements>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
12 Rscript -e 'source("${plot_eic}")'
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
13 ]]></command>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
14 <configfiles>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
15 <configfile name="plot_eic">
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
16 library(xcms)
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
17 library(MsExperiment)
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
18 library(Spectra)
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
19 mse = readMsExperiment(file.path('${input}'))
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
20 offset = ${tolerance_ppm} * 1e-6 * ${mz_value}
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
21 chr = chromatogram(mse, mz = ${mz_value} + c(-offset, offset), msLevel = ${mslevel})
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
22 png(filename = '${output_filename}')
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
23 plot(chr)
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
24 dev.off()
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
25 </configfile>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
26 </configfiles>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
27 <inputs>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
28 <expand macro="base_params"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
29 <param type="integer" value="1" name="mslevel" min="1" label="MS Level" help="MS level for the EIC"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
30 </inputs>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
31 <outputs>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
32 <data name="output_filename" format="png" label="EIC plot at m/z=$mz_value of $input.element_identifier" />
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
33 </outputs>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
34 <tests>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
35 <test>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
36 <param name="input" value="xcms_plot_eic_testdata.mzML"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
37 <param name="mz_value" value="153.06614"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
38 <param name="tolerance_ppm" value="10"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
39 <param name="mslevel" value="1"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
40 <output name="output_filename" file="eic_plot.png" compare="sim_size"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
41 </test>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
42 </tests>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
43 <help><![CDATA[
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
44 This tool plots the extracted ion chromatogram (EIC) from an mzML file, using a provided m/z value.
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
45 It uses a default tolerance of 10 ppm and operates at mslevel 1 by default.
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
46 More information and detailed instructions can be found in the tutorial at: https://jorainer.github.io/xcmsTutorials/articles/xcms-preprocessing.html#data-visualization
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
47 ]]></help>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
48 <expand macro="citations"/>
51015f22fcb7 planemo upload for repository https://github.com/workflow4metabolomics/tools-metabolomics/ commit eca29d4347fe2f4802091c4a06715232a6fd9253
workflow4metabolomics
parents:
diff changeset
49 </tool>