annotate README.rst @ 0:e01de823e919 draft default tip

Uploaded
author biotechcoder
date Fri, 01 May 2015 05:41:51 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
1 README
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
2 ======
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
3
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
4 `riboSeqR <http://bioconductor.org/packages/release/bioc/html/riboSeqR.html>`_
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
5 integration for `Galaxy <http://galaxyproject.org/>`_ /
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
6 `RiboGalaxy <http://ribogalaxy.ucc.ie/>`_.
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
7
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
8 Included tools
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
9 --------------
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
10 In the order in which they are run
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
11
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
12 #. **Prepare riboSeqR Input**
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
13
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
14 Prepare riboSeqR format input files from alignment files (SAM format,
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
15 Ribo-Seq or RNA-Seq alignments).
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
16
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
17 #. **Triplet Periodicity**
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
18
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
19 Plot triplet periodicity for different read lengths.
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
20
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
21 #. **Metagene Analysis**
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
22
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
23 Metagene analysis.
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
24
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
25 #. **Plot Ribosome Profile**
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
26
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
27 Plot Ribosome profile and output Ribo/RNA counts.
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
28
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
29 Requirements
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
30 ------------
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
31 * **R** (Tested with version ``3.2.0``).
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
32
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
33 * **riboSeqR** (Tested with version ``1.0.4``).
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
34
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
35 * **rpy2** Python module to interface with R. (Tested with version ``2.5.5``).
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
36
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
37 Install R, riboSeqR, rpy2 on Ubuntu 14.04
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
38 .........................................
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
39 riboseqR requires recent R packages. Install R from CRAN mirror
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
40 (`instructions <http://cran.r-project.org/bin/linux/ubuntu/README>`_).
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
41
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
42 In summary:
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
43
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
44 Add to ``/etc/apt/sources.list`` ::
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
45
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
46 deb http://ftp.heanet.ie/mirrors/cran.r-project.org/bin/linux/ubuntu trusty/
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
47
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
48 Install R::
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
49
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
50 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E084DAB9
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
51 sudo apt-get update
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
52 sudo apt-get install r-base r-base-dev
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
53
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
54 To install riboSeqR R package::
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
55
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
56 sudo R
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
57 source("http://bioconductor.org/biocLite.R")
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
58 biocLite("riboSeqR")
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
59
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
60 Install ``rpy2`` python module. Either using ``sudo``::
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
61
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
62 sudo apt-get install python-rpy2
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
63
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
64 or install in a virtualenv ::
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
65
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
66 pip install rpy2
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
67
e01de823e919 Uploaded
biotechcoder
parents:
diff changeset
68 You can now install **riboseqr** from the toolshed.