annotate xcms_plot_chromatogram.xml @ 0:fe1f0f16d9e6 draft

planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
author lecorguille
date Thu, 08 Mar 2018 02:48:44 -0500
parents
children e6fdadaf039e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
1 <tool id="xcms_plot_chromatogram" name="xcms plot chromatogram" version="@WRAPPER_VERSION@.0">
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
2 <description>Plot base peak intensity chromatogram (BPI) and total ion chromatogram (TIC) from xcms experience</description>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
3
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
4 <macros>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
5 <import>macros.xml</import>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
6 </macros>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
7
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
8 <expand macro="requirements"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
9 <expand macro="stdio"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
10
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
11 <command><![CDATA[
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
12 @COMMAND_XCMS_SCRIPT@/xcms_plot_chromatogram.r
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
13
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
14 image '$image'
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
15
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
16 @COMMAND_FILE_LOAD@
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
17 ]]></command>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
18
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
19 <inputs>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
20 <param name="image" type="data" format="rdata.xcms.raw,rdata.xcms.group,rdata.xcms.retcor,rdata.xcms.fillpeaks,rdata" label="@INPUT_IMAGE_LABEL@" help="@INPUT_IMAGE_HELP@ from: findChromPeaks, groupChromPeaks or adjustRtime" />
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
21
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
22 <expand macro="input_file_load"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
23 </inputs>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
24
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
25 <outputs>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
26 <data name="ticsPdf" format="pdf" label="${image.name[:-6]}.TICs.pdf" from_work_dir="TICs.pdf"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
27 <data name="bpisPdf" format="pdf" label="${image.name[:-6]}.BPIs.pdf" from_work_dir="BPIs.pdf" />
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
28 </outputs>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
29
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
30 <tests>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
31 <test>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
32 <param name="image" value="faahKO-single.xset.merged.group.retcor.RData"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
33 <expand macro="test_file_load_single"/>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
34 <output name="ticsPdf" value="TICs.pdf" ftype="pdf" compare="sim_size" delta="600" />
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
35 <output name="bpisPdf" value="BPIs.pdf" ftype="pdf" compare="sim_size" delta="600" />
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
36 </test>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
37 </tests>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
38
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
39 <help><![CDATA[
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
40
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
41 @HELP_AUTHORS@
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
42
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
43 ======================
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
44 xcms plot chromatogram
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
45 ======================
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
46
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
47 -----------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
48 Description
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
49 -----------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
50
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
51 This tool will plot base peak intensity chromatogram (BPI) and total ion chromatogram (TIC) from xcms experience
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
52
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
53
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
54 -----------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
55 Workflow position
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
56 -----------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
57
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
58 **Upstream tools**
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
59
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
60 ========================= ================= =================== ==========
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
61 Name output file format parameter
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
62 ========================= ================= =================== ==========
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
63 xcms.xcmsSet xset.RData rdata.xcms.raw RData file
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
64 ------------------------- ----------------- ------------------- ----------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
65 xcms.retcor xset.RData rdata.xcms.retcor RData file
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
66 ========================= ================= =================== ==========
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
67
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
68 .. image:: xcms_plot_chromatogram_workflow.png
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
69
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
70
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
71 ------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
72 Output files
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
73 ------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
74
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
75 **Total Ion Current (TIC) chromatogram**
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
76 | Sum of intensity (Y) of all ions detected at each retention time(X)
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
77
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
78 **Base Peak Intensity Chromatogram (BPI)**
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
79 | Sum of intensity (Y) of the most intense peaks at each retention time(X)
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
80
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
81 ---------------------------------------------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
82
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
83 Changelog/News
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
84 --------------
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
85
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
86 **Version 3.0.0.0 - 07/03/2018**
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
87
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
88 - NEW: This new tool will plot base peak intensity chromatogram (BPI) and total ion chromatogram (TIC) from xcms experience. It will replace the one created by xcmsSet and retcor tools.
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
89
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
90 ]]></help>
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
91
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
92 <expand macro="citation" />
fe1f0f16d9e6 planemo upload for repository https://github.com/workflow4metabolomics/xcms commit cfb08142b6bfb78002b4e0d7775adb1a58e66c33-dirty
lecorguille
parents:
diff changeset
93 </tool>