annotate xcms_differential_analysis.xml @ 49:f772a5caa86a

Added more options and better documentation. Added MsClust support for parsing XCMS alignment results. Improved output reports for XCMS wrappers. New tools.
author pieter.lukasse@wur.nl
date Wed, 10 Dec 2014 22:03:27 +0100
parents e67149fbff20
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 41
diff changeset
1 <tool id="xcms_differential_analysis" name="XCMS Differential Analsysis" version="0.0.4">
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description> Runs xcms diffreport function for differential Analsysis</description>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
3 <requirements>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
4 <requirement type="package" version="3.1.1">R_bioc_metams</requirement>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
5 </requirements>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
6 <command interpreter="Rscript">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
7 xcms_differential_analysis.r
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
8 $xsetData
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 41
diff changeset
9 "$class1"
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 41
diff changeset
10 "$class2"
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
11 $topcount
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
12 $outTable
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
13 $htmlReportFile
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
14 $htmlReportFile.files_path
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 41
diff changeset
15 $outLogFile
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
16 </command>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
17 <inputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
18
e67149fbff20 small changes/improvements;
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"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
20
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
21
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
22 <param name="class1" type="text" size="30" label="Class1 name" value="" help="Name of first class for the comparison"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
23 <param name="class2" type="text" size="30" label="Class2 name" value="" help="Name of second class for the comparison"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
24
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
25 <param name="topcount" type="integer" size="10" value="10" label="Number of items to return" help="Top X differential items. E.g. if 10, it will return top 10 differential items." />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
26
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
27 </inputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
28 <outputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
29 <data name="outTable" format="tabular" label="${tool.name} on ${on_string} - Top differential items (TSV)"/>
49
f772a5caa86a Added more options and better documentation.
pieter.lukasse@wur.nl
parents: 41
diff changeset
30 <data name="outLogFile" format="txt" label="${tool.name} on ${on_string} - log (LOG)" hidden="True"/>
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
31 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - differential report (HTML)"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
32 </outputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
33 <tests>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
34 <test>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
35 </test>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
36 </tests>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
37 <help>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
38
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
39 .. class:: infomark
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
40
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
41 Runs xcms diffreport for showing the most significant differences between two sets/classes of samples. This tool also creates extracted ion chromatograms (EICs) for
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
42 the most significant differences. The figure below shows an example of such an EIC.
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
43
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
44 .. image:: $PATH_TO_IMAGES/diffreport.png
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
45
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
46
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
47
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
48
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
49 </help>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
50 <citations>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
51 <citation type="doi">10.1021/ac051437y</citation> <!-- example
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
52 see also https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
53 -->
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
54 </citations>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
55 </tool>