annotate xcms_get_alignment_eic.xml @ 2:44bfd7e34b39

added comment
author pieter.lukasse@wur.nl
date Thu, 19 Mar 2015 10:39:27 +0100
parents dffc38727496
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool id="xcms_get_alignment_eic" name="XCMS Get Alignment EICs" version="0.0.4">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description> Extracts alignment EICs from feature alignment data</description>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
3 <requirements>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
4 <requirement type="package" version="3.1.1">R_bioc_metams</requirement>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
5 </requirements>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
6 <command interpreter="Rscript">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
7 xcms_get_alignment_eic.r
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
8 $xsetData
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
9 $rtStart
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
10 $rtEnd
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
11 $minNrSamples
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
12 "$sampleNames"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
13 $htmlReportFile
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
14 $htmlReportFile.files_path
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
15 $outLogFile
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
16 </command>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
17 <inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
18
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
19 <param name="xsetData" type="data" format="rdata" label="xset xcms data file" help="E.g. output data file resulting from METAMS run"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
20
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
21
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
22 <param name="rtStart" type="integer" value="" size="10" label="RT start" help="Start of Retention Time region to plot" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
23 <param name="rtEnd" type="integer" value="" size="10" label="RT end" help="End of Retention Time region to plot" />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
24
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
25 <param name="minNrSamples" type="integer" size="10" value="10" label="Minimum number of samples in which aligned feature should be found" help="Can also read this as: Minimum
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
26 number of features in alignment. E.g. if set to 10, it means the alignment should consist of at least 10 peaks from 10 different samples aligned together." />
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
27
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
28 <param name="sampleNames" type="text" area="true" size="10x70" label="List of sample names"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
29 value="sampleName1,sampleName2,etc"
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
30 help="Comma or line-separated list of sample names. Optional field where you can specify the subset of samples
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
31 to use for the EIC plots. NB: if your dataset has many samples, specifying a subset here can significantly speed up the processing time." >
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
32 <sanitizer>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
33 <!-- this translates from line-separated to comma separated list, removes quotes -->
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
34 <valid/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
35 <mapping initial="none">
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
36 <add source="&#10;" target=","/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
37 <add source="&#13;" target=""/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
38 <add source="&quot;" target=""/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
39 </mapping>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
40 </sanitizer>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
41 </param>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
42
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
43
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
44 </inputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
45 <outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
46 <data name="outLogFile" format="txt" label="${tool.name} on ${on_string} - log (LOG)" hidden="True"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
47 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - EIC(s) report (HTML)"/>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
48 </outputs>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
49 <tests>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
50 <test>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
51 </test>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
52 </tests>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
53 <help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
54
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
55 .. class:: infomark
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
56
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
57 This tool finds the alignments in the specified RT window and extracts alignment EICs from feature alignment data using XCMS's getEIC method.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
58 It produces a HTML report showing the EIC plots and the mass list of each alignment. The figure below shows an example of such an EIC plot, showing also the difference between
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
59 two classes, with extra alignment information beneath it.
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
60
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
61 .. image:: $PATH_TO_IMAGES/diffreport.png
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
62
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
63 Alignment id: 1709. m/z list of peaks in alignment:
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
64 614.002922098482,613.998019830021,614.000382307519,613.998229980469,613.998229980469
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
65
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
66
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
67 </help>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
68 <citations>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
69 <citation type="doi">10.1021/ac051437y</citation> <!-- example
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
70 see also https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
71 -->
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
72 </citations>
dffc38727496 initial commit
pieter.lukasse@wur.nl
parents:
diff changeset
73 </tool>