annotate README.md @ 0:1660665c081e draft

#issue9 branch Updating - - Fxx
author fgiacomoni
date Thu, 19 Nov 2020 14:28:46 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
1 INTRODUCTION
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
2 ============
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
3
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
4 This tool is part of the xcms/camera/XSeeker workflow, and it inserts
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
5 between camera and XSeeker. It takes in input a rdata producd by camera,
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
6 gather some data from mzxml original files, and create a database
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
7 containing all these informations organized in such a way that XSeeker
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
8 has just to display the data without manipulating them anymore, which
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
9 makes it a lot faster and easier to use.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
10
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
11
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
12 PREREQUISITES
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
13 =============
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
14 There is not real preriquesite to understand how this tool works
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
15 and to modify it. There is a single R script - XSeekerPreparator.R - that do
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
16 all the work.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
17
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
18 You can make this tool work alone, but you can integrate it with galaxy.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
19 In this case, you need to have a galaxy instance you can configure.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
20 It is also recomended to have access to the datatypes definitions (in
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
21 the python files) to make the outputs recognized by galaxy as XSeeker's
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
22 database files.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
23
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
24
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
25 DESIGN
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
26 ======
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
27 This tool is very simple and does a little number of things, so there is
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
28 only a single file: XSeekerPreparator.R .
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
29 There is a test/test.sh file that can be used as an example to know how
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
30 to use this tool.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
31
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
32 You will find the galaxy patches in the galaxy/ directory. These files
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
33 are not meant to be copy/paste-ed. The content of these files must be
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
34 added to the existing files of your galaxy instance
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
35
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
36
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
37 REQUIREMENT
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
38 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
39
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
40 - R-4.0.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
41 - optparse
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
42 - xcms
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
43 - blob
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
44 - fst
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
45 - DBModelR
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
46 - stringr
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
47 - optparse
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
48 - galaxy (optional)
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
49
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
50 #### R 4.0.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
51 - `export R_MAJOR=4 R_VERSION=4.0.0 BUILD_TARGET_DIR=~/R/`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
52 - `wget https://cran.rstudio.com/src/base/R-${R_MAJOR}/R-${R_VERSION}.tar.gz`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
53 - `tar -xf "R-${R_VERSION}.tar.gz"`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
54 - `cd ./R-${R_VERSION}/`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
55 - `./configure --prefix="${BUILD_TARGET_DIR}" --with-readline="no" --with-x="no"`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
56 - `export CC="gcc -fPIC"`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
57 - `make`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
58 - `make install`
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
59
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
60 #### Packages
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
61 ```bash
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
62 ~/R/bin/R -e "
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
63 install.packages(
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
64 c(
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
65 'optparse',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
66 'blob',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
67 'fst',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
68 'stringr',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
69 'optparse',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
70 'RSQLite',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
71 'remotes',
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
72 'BiocManager'
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
73 ), repos='https://cloud.r-project.org'
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
74 )" && \
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
75 ~/R/bin/R -e '
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
76 remotes::install_github("LainPavot/DBModelR", force=TRUE)
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
77 ' && \
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
78 ~/R/bin/R -e '
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
79 BiocManager::install("xcms")
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
80 '
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
81 ```
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
82
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
83 #### galaxy
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
84 ```bash
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
85 git clone https://github.com/galaxyproject/galaxy
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
86 ```
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
87
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
88 DEPLOY
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
89 =====
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
90
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
91 Install the tool in galaxy:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
92 Open each file in the galaxy/ directory and copy their content to their
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
93 respective files in your galaxy instance.
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
94 Copy XSeekerPreparator.R in galaxy/tool/tools/LC-MSMS/
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
95
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
96 METADATA
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
97 --------
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
98
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
99 - **@name**: XSeekerPreparator
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
100 - **@version**: 1.1.2
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
101 - **@authors**: Lain Pavot
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
102 - **@date creation**: 15/09/2020
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
103
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
104 NOTES
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
105 -----
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
106 Developed and tested using:
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
107
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
108 - R 4.0.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
109 - optparse 1.6.6
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
110 - xcms 3.10.2
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
111 - blob 1.2.1
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
112 - fst 0.9.4
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
113 - DBModelR
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
114 - stringr 1.4.0
1660665c081e #issue9 branch Updating - - Fxx
fgiacomoni
parents:
diff changeset
115 - galaxy 21.01