annotate metaMS/xcms_get_alignment_eic.xml @ 15:05ff1c55db84

fix for rankfilter, removed pfd read functional
author linda.bakker@wur.nl <linda.bakker@wur.nl>
date Fri, 20 Mar 2015 17:11:04 +0100
parents 4393f982d18f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool id="xcms_get_alignment_eic" name="XCMS Get Alignment EICs" version="0.0.4">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description> Extracts alignment EICs from feature alignment data</description>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
3 <requirements>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
4 <requirement type="package" version="3.1.1">R_bioc_metams</requirement>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
5 </requirements>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
6 <command interpreter="Rscript">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
7 xcms_get_alignment_eic.r
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
8 $xsetData
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
9 $rtStart
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
10 $rtEnd
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
11 $minNrSamples
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
12 "$sampleNames"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
13 $htmlReportFile
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
14 $htmlReportFile.files_path
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
15 $outLogFile
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
16 </command>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
17 <inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
18
4393f982d18f reorganized sources
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"/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
20
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
21
4393f982d18f reorganized sources
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" />
4393f982d18f reorganized sources
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" />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
24
4393f982d18f reorganized sources
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
4393f982d18f reorganized sources
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." />
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
27
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
28 <param name="sampleNames" type="text" area="true" size="10x70" label="List of sample names"
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
29 value="sampleName1,sampleName2,etc"
4393f982d18f reorganized sources
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
4393f982d18f reorganized sources
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." >
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
32 <sanitizer>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
33 <!-- this translates from line-separated to comma separated list, removes quotes -->
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
34 <valid/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
35 <mapping initial="none">
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
36 <add source="&#10;" target=","/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
37 <add source="&#13;" target=""/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
38 <add source="&quot;" target=""/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
39 </mapping>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
40 </sanitizer>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
41 </param>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
42
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
43
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
44 </inputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
45 <outputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
46 <data name="outLogFile" format="txt" label="${tool.name} on ${on_string} - log (LOG)" hidden="True"/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
47 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - EIC(s) report (HTML)"/>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
48 </outputs>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
49 <tests>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
50 <test>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
51 </test>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
52 </tests>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
53 <help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
54
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
55 .. class:: infomark
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
56
4393f982d18f reorganized sources
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.
4393f982d18f reorganized sources
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
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
59 two classes, with extra alignment information beneath it.
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
60
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
61 .. image:: $PATH_TO_IMAGES/diffreport.png
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
62
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
63 Alignment id: 1709. m/z list of peaks in alignment:
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
64 614.002922098482,613.998019830021,614.000382307519,613.998229980469,613.998229980469
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
65
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
66
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
67 </help>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
68 <citations>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
69 <citation type="doi">10.1021/ac051437y</citation> <!-- example
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
70 see also https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
71 -->
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
72 </citations>
4393f982d18f reorganized sources
pieter.lukasse@wur.nl
parents:
diff changeset
73 </tool>