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

Uploaded
author cs76
date Mon, 07 Dec 2015 06:27:48 -0500
parents
children
comparison
equal deleted inserted replaced
4:8b543e92789f 5:16b69e94e08e
1 <tool id="ipo" name="XCMS - IPO" version="0.1.0">
2 <description>: A Tool for automated Optimization of XCMS Parameters</description>
3 <command interpreter="Rscript">ipo.R $input $html_file $html_file.files_path</command>
4 <inputs>
5 <param format="cdf" name="input" type="data" label="Source file"/>
6 </inputs>
7 <outputs>
8 <data format="html" name="html_file" label="ipo_output.html"/>
9 </outputs>
10 <help>
11 **IPO Galaxy - Version 0.1**
12
13 v0.1 uses the following XCMS parameters as default
14
15 > peakpickingParameters$min_peakwidth : c(10,20)
16
17 > peakpickingParameters$max_peakwidth : c(26,42)
18
19 > peakpickingParameters$ppm : 20
20
21 > peakpickingParameters$nSlaves : 4
22
23 > type : "centWave"
24
25 -----
26
27 **IPO optimization process**
28
29 .. image:: https://raw.githubusercontent.com/glibiseller/IPO/master/vignettes/FlowChart.jpg
30 :height: 400
31 :width: 429
32
33 -----
34
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.
36
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.
38
39 -----
40
41 Github Repo IPO: https://github.com/glibiseller/IPO/blob/master/vignettes/IPO.Rmd
42
43 Publication : http://www.biomedcentral.com/1471-2105/16/118
44
45 -----
46
47 **Dependencies**
48
49 Install all dependencies for IPO
50
51 > source("http://bioconductor.org/biocLite.R")
52
53 > biocLite("CAMERA")
54
55 > biocLite("xcms")
56
57 > install.packages("rsm")
58
59 Install RTools
60
61 For windows:
62
63 Download and install RTools from http://cran.r-project.org/bin/windows/Rtools/
64
65 For Unix:
66
67 Install the R-development-packages (r-devel or r-base-dev)
68
69 Install packages needed for installation from github
70
71 > install.packages("devtools")
72
73 Install IPO
74
75 > library("devtools")
76
77 > install_github("glibiseller/IPO")
78
79 </help>
80 </tool>