annotate ipo.xml @ 5:16b69e94e08e draft default tip

Uploaded
author cs76
date Mon, 07 Dec 2015 06:27:48 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
16b69e94e08e Uploaded
cs76
parents:
diff changeset
1 <tool id="ipo" name="XCMS - IPO" version="0.1.0">
16b69e94e08e Uploaded
cs76
parents:
diff changeset
2 <description>: A Tool for automated Optimization of XCMS Parameters</description>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
3 <command interpreter="Rscript">ipo.R $input $html_file $html_file.files_path</command>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
4 <inputs>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
5 <param format="cdf" name="input" type="data" label="Source file"/>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
6 </inputs>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
7 <outputs>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
8 <data format="html" name="html_file" label="ipo_output.html"/>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
9 </outputs>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
10 <help>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
11 **IPO Galaxy - Version 0.1**
16b69e94e08e Uploaded
cs76
parents:
diff changeset
12
16b69e94e08e Uploaded
cs76
parents:
diff changeset
13 v0.1 uses the following XCMS parameters as default
16b69e94e08e Uploaded
cs76
parents:
diff changeset
14
16b69e94e08e Uploaded
cs76
parents:
diff changeset
15 > peakpickingParameters$min_peakwidth : c(10,20)
16b69e94e08e Uploaded
cs76
parents:
diff changeset
16
16b69e94e08e Uploaded
cs76
parents:
diff changeset
17 > peakpickingParameters$max_peakwidth : c(26,42)
16b69e94e08e Uploaded
cs76
parents:
diff changeset
18
16b69e94e08e Uploaded
cs76
parents:
diff changeset
19 > peakpickingParameters$ppm : 20
16b69e94e08e Uploaded
cs76
parents:
diff changeset
20
16b69e94e08e Uploaded
cs76
parents:
diff changeset
21 > peakpickingParameters$nSlaves : 4
16b69e94e08e Uploaded
cs76
parents:
diff changeset
22
16b69e94e08e Uploaded
cs76
parents:
diff changeset
23 > type : "centWave"
16b69e94e08e Uploaded
cs76
parents:
diff changeset
24
16b69e94e08e Uploaded
cs76
parents:
diff changeset
25 -----
16b69e94e08e Uploaded
cs76
parents:
diff changeset
26
16b69e94e08e Uploaded
cs76
parents:
diff changeset
27 **IPO optimization process**
16b69e94e08e Uploaded
cs76
parents:
diff changeset
28
16b69e94e08e Uploaded
cs76
parents:
diff changeset
29 .. image:: https://raw.githubusercontent.com/glibiseller/IPO/master/vignettes/FlowChart.jpg
16b69e94e08e Uploaded
cs76
parents:
diff changeset
30 :height: 400
16b69e94e08e Uploaded
cs76
parents:
diff changeset
31 :width: 429
16b69e94e08e Uploaded
cs76
parents:
diff changeset
32
16b69e94e08e Uploaded
cs76
parents:
diff changeset
33 -----
16b69e94e08e Uploaded
cs76
parents:
diff changeset
34
16b69e94e08e Uploaded
cs76
parents:
diff changeset
35 To optimize parameters different values (levels) have to tested for these parameters. To efficiently test many different levels design of experiment (DoE) is used. Box-Behnken and central composite designs set three evenly spaced levels for each parameter. The method 'getDefaultXcmsSetStartingParams' provides default values for the lower and upper levels defining a range. Since the levels are evenly spaced the middle level or center point is calculated automatically. To edit the starting levels of a parameter set the lower and upper level as desired. If a parameter should not be optimized, set a single default value for 'xcms' processing, do not set this parameter to NULL.
16b69e94e08e Uploaded
cs76
parents:
diff changeset
36
16b69e94e08e Uploaded
cs76
parents:
diff changeset
37 The method 'getDefaultXcmsSetStartingParams' creates a list with default values for the optimization of the peak picking methods 'centWave' or 'matchedFilter'. To choose between these two method set the parameter accordingly.
16b69e94e08e Uploaded
cs76
parents:
diff changeset
38
16b69e94e08e Uploaded
cs76
parents:
diff changeset
39 -----
16b69e94e08e Uploaded
cs76
parents:
diff changeset
40
16b69e94e08e Uploaded
cs76
parents:
diff changeset
41 Github Repo IPO: https://github.com/glibiseller/IPO/blob/master/vignettes/IPO.Rmd
16b69e94e08e Uploaded
cs76
parents:
diff changeset
42
16b69e94e08e Uploaded
cs76
parents:
diff changeset
43 Publication : http://www.biomedcentral.com/1471-2105/16/118
16b69e94e08e Uploaded
cs76
parents:
diff changeset
44
16b69e94e08e Uploaded
cs76
parents:
diff changeset
45 -----
16b69e94e08e Uploaded
cs76
parents:
diff changeset
46
16b69e94e08e Uploaded
cs76
parents:
diff changeset
47 **Dependencies**
16b69e94e08e Uploaded
cs76
parents:
diff changeset
48
16b69e94e08e Uploaded
cs76
parents:
diff changeset
49 Install all dependencies for IPO
16b69e94e08e Uploaded
cs76
parents:
diff changeset
50
16b69e94e08e Uploaded
cs76
parents:
diff changeset
51 > source("http://bioconductor.org/biocLite.R")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
52
16b69e94e08e Uploaded
cs76
parents:
diff changeset
53 > biocLite("CAMERA")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
54
16b69e94e08e Uploaded
cs76
parents:
diff changeset
55 > biocLite("xcms")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
56
16b69e94e08e Uploaded
cs76
parents:
diff changeset
57 > install.packages("rsm")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
58
16b69e94e08e Uploaded
cs76
parents:
diff changeset
59 Install RTools
16b69e94e08e Uploaded
cs76
parents:
diff changeset
60
16b69e94e08e Uploaded
cs76
parents:
diff changeset
61 For windows:
16b69e94e08e Uploaded
cs76
parents:
diff changeset
62
16b69e94e08e Uploaded
cs76
parents:
diff changeset
63 Download and install RTools from http://cran.r-project.org/bin/windows/Rtools/
16b69e94e08e Uploaded
cs76
parents:
diff changeset
64
16b69e94e08e Uploaded
cs76
parents:
diff changeset
65 For Unix:
16b69e94e08e Uploaded
cs76
parents:
diff changeset
66
16b69e94e08e Uploaded
cs76
parents:
diff changeset
67 Install the R-development-packages (r-devel or r-base-dev)
16b69e94e08e Uploaded
cs76
parents:
diff changeset
68
16b69e94e08e Uploaded
cs76
parents:
diff changeset
69 Install packages needed for installation from github
16b69e94e08e Uploaded
cs76
parents:
diff changeset
70
16b69e94e08e Uploaded
cs76
parents:
diff changeset
71 > install.packages("devtools")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
72
16b69e94e08e Uploaded
cs76
parents:
diff changeset
73 Install IPO
16b69e94e08e Uploaded
cs76
parents:
diff changeset
74
16b69e94e08e Uploaded
cs76
parents:
diff changeset
75 > library("devtools")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
76
16b69e94e08e Uploaded
cs76
parents:
diff changeset
77 > install_github("glibiseller/IPO")
16b69e94e08e Uploaded
cs76
parents:
diff changeset
78
16b69e94e08e Uploaded
cs76
parents:
diff changeset
79 </help>
16b69e94e08e Uploaded
cs76
parents:
diff changeset
80 </tool>