annotate README.md @ 3:fa97d16330be draft

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