annotate README.txt @ 53:47310c4fb725

Uploaded
author m-zytnicki
date Fri, 10 Jan 2014 08:57:02 -0500
parents 2c0c0a89fad7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
1 ----------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
2 | NAME |
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
3 ----------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
4 S-MART
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
5
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
6
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
7 Description
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
8 -----------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
9 Several tools are now available for mapping high-throughput sequencing data from a genome, but few can extract biological knowledge from the mapped reads. We have developed a toolbox, S-MART, which handles mapped RNA-Seq and ChIP-Seq data.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
10
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
11 S-MART is an intuitive and lightweight tool, performing several tasks that are usually required during the analysis of mapped RNA-Seq and ChIP-Seq reads, including data selection and data visualization.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
12
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
13 S-MART does not require a computer science background and thus can be used by all biologists through a graphical interface. S-MART can run on any personal computer, yielding results within an hour for most queries.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
14
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
15
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
16 Copyright
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
17 ---------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
18 Copyright INRA-URGI 2009-2013
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
19
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
20
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
21 Authors
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
22 -------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
23 Matthias Zytnicki
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
24
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
25
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
26 Contact
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
27 -------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
28 urgi-contact@versailles.inra.fr
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
29
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
30
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
31 License
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
32 -------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
33 This library is distributed under the terms of the CeCILL license
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
34 (http://www.cecill.info/index.en.html).
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
35 See the LICENSE.txt file.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
36
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
37
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
38 Installation under Galaxy
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
39 -------------------------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
40 S-MART is available under the Galaxy Tool Shed: http://toolshed.g2.bx.psu.edu/
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
41 Remember to set the variables "tool_config_file" and "tool_dependency_dir" accordingly. Please look up the Galaxy Tool Shed wiki to know more about it.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
42 It assumes you have R installed, as well as two packages: RColorBrewer (for colors in graphics), and Hmisc (for statistics). You can install them as root with the commands:
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
43 - R --slave --no-save --no-restore --quiet -e 'if("RColorBrewer" %in% rownames(installed.packages()) == FALSE){install.packages("RColorBrewer", repos = c("http://cran.rstudio.com/"), dependencies = TRUE)}'
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
44 - R --slave --no-save --no-restore --quiet -e 'if("Hmisc" %in% rownames(installed.packages()) == FALSE){install.packages("Hmisc", repos = c("http://cran.rstudio.com/"), dependencies = TRUE)}'
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
45
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
46 Optionally, you can organize the layout of S-MART tools following these instructions. This way, all the tools will be correctly sorted and appear in categories.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
47 - Locate the directory where S-MART has been installed: probably in "<galaxy install dir>/shed_tool/toolshed.g2.bx.psu.edu/repos/yufei-luo/s_mart/XXX/s_mart/"
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
48 - Create a symbolic link "<galaxy install dir>/tools/s_mart" directing to "<S-MART install dir>/SMART/galaxy/"
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
49 - Paste the content of "<S-MART install dir>/SMART/galaxy/tool_conf.xml" to your local "<galaxy install dir>/tool_conf.xml", for instance, right before the </toolbox> mark-up.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
50 - Remove the S-MART layout in "<galaxy install dir>/shed_tool_conf.xml" (the name may vary depending on your "universe_wgsi.ini" file) which has been automatically generated: remove the whole block between the markup <section id="s-mart" name="S-MART" version="XXX"> and the corresponding </section>.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
51 - Restart Galaxy to complete the install.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
52
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
53
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
54 Stand-alone installation
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
55 ------------------------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
56 This product needs the following softwares :
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
57 - R, under the GNU General Public License, and several R package (under the same License)
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
58 - Python, under the Python License, compatible with the GNU General Public License
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
59 - Java, under the GNU General Public License
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
60
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
61
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
62 Instructions
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
63 ------------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
64 Further installation instructions and the user guide are available in the file "doc.pdf".
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
65
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
66
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
67 Acknowledgements
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
68 ----------------
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
69 Many thanks go helping developers:
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
70 - Yufei Luo
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
71 - the URGI team
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
72 and the beta-testers:
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
73 - Claire Toffano-Nioche
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
74 - Claire Kuchly
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
75 - among others...