Mercurial > repos > marie-tremblay-metatoul > nmr_bucketing

annotate MANUAL_INSTALL.txt @ 2:761312f27add draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 32fa2b6914a12c8ee2109183af6d4b3ad60d8f13-dirty
author lecorguille
date Fri, 12 Aug 2016 03:45:27 -0400
parents a99a6026c972
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
1 Instructions to integrate the "NMR bucketing" tool into a local instance of Galaxy
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
2 Version February 2015 M Tremblay-Franco
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
3
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
4
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
5 ## --- R bin and Packages : --- ##
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
6 R version 3.0.2 (2013-09-25) -- "Frisbee Sailing"
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
7 Platform: x86_64-redhat-linux-gnu (64-bit)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
8
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
9 Install the "batch" library, necessary for parseCommandArgs function and the "pracma" library, nessecary for cumtrapz function:
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
10 - Download package source (*.tar.gz file) from your favorite CRAN (http://www.r-project.org/)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
11 For example: http://cran.univ-lyon1.fr/
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
12
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
13 - Install package in your R session
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
14 install.packages("path/package_name.tar.gz",lib="path",repos=NULL)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
15 For Example: install.packages("/usr/lib64/R/library/pracma_1.8.3.tar",lib="/usr/lib64/R/library",repos=NULL)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
16
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
17 - Finally, load the package into your R session
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
18 library(batch)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
19 library(pracma)
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
20
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
21
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
22 ## --- Config : --- ##
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
23 - Edit the file "/galaxy/dist/galaxy-dist/tool_conf.xml" and add
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
24 <section id="id_name" name="Name">
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
25 <tool file="path/NmrBucketing_xml.xml" />
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
26 </section>
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
27 to create a new section containing the NMR_Bucketing tool
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
28 or add
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
29 <tool file="path/NmrBucketing_xml.xml" />
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
30 in an existing section
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
31
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
32 - Put the three files NmrBucketing_xml.xml, NmrBucketing_wrapper.R and NmrBucketing_script.R in a same directory
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
33 For example, path=/galaxy/dist/galaxy-dist/tools/stats
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
34
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
35 - Edit the NmrBucketing_xml.xml file and change the path in the following lines
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
36 # R script
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
37 R --vanilla --slave --no-site-file --file=path/NmrBucketing_wrapper.R --args
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
38
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
39 ## Library name for raw files storage
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
40 library path/$library
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
41
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
42 ## --- XML help part --- ##
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
43 one image:
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
44 Copy the 'Mth_Architecture_Repertoire_Bruker.png' file within the directory to your galaxy-dist/static/images/
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
45
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
46
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
47 - Activate the "user_library_import_dir" in your /galaxy/dist/galaxy-dist/universe_wsgi.ini and create the users directories in this path, for example:
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
48
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
49 #In universe_wsgi.ini
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
50 user_library_import_dir = /projet/sbr/galaxy/import/user
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
51
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
52 #Create the user "myaccount" in this path
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
53
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
54 User path: /projet/sbr/galaxy/import/user/myaccount@sb-roscoff.fr
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
55
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
56
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
57
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
58
a99a6026c972 planemo upload for repository https://github.com/workflow4metabolomics/nmr_bucketing commit 44fd4fc42930d2e9ad7b77cf575f2231547de15c
marie-tremblay-metatoul
parents:
diff changeset
59 Finally, restart Galaxy