Mercurial > repos > vimalkumarvelayudhan > riboseqr_wrapper

annotate README.rst @ 3:d7ce95ccf54f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change R data file format in xml wrappers (rda -> RData) Add test data, sample workflow. Updated README with instructions on testing.
author Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
date Wed, 22 Jul 2015 12:07:39 +0100
parents c34c364ce75d
children de357bab306d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
1 riboseqr_wrapper
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
2 ================
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
3 `riboSeqR <http://bioconductor.org/packages/3.0/bioc/html/riboSeqR.html>`_
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
4 integration for `Galaxy <http://galaxyproject.org/>`_ and
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
5 `RiboGalaxy <http://ribogalaxy.ucc.ie/>`_.
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
6
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
7 Included tools
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
8 --------------
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
9 In the order they are run
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
10
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
11 1. Prepare riboSeqR Input - Prepare riboSeqR format input files from SAM format alignment files.
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
12 The SAM format files should be obtained by aligning Ribo-Seq and RNA-Seq data to the transcriptome.
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
13 (RNA-Seq data is optional but required for Differential translation analysis).
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
14
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
15 2. Triplet Periodicity - Plot triplet periodicity for different read lengths.
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
16
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
17 3. Metagene Analysis
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
18
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
19 4. Plot Ribosome Profile
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
20
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
21 [OR]
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
22
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
23 Differential Translation Analysis - Get Ribo and RNA-Seq counts with riboSeqR. Perform differential
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
24 translation analysis with baySeq.
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
25
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
26 Dependencies
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
27 ------------
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
28 Tested on Ubuntu Linux 14.04 LTS, 64-bit. Dependencies should install automatically on Linux 64-bit.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
29
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
30 R ``3.1.2``, riboSeqR ``1.0.5``, baySeq ``2.0.50``, rpy2 ``2.3.10``.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
31
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
32 How to test
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
33 -----------
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
34 1. Upload the following test data files from the test-data folder.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
35
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
36 Prepare riboSeqR input (R data file)
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
37
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
38 rsem_chlamy236_deNovo.transcripts.fa
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
39
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
40 2. A workflow with test data is included in this repository. All tools with the exception of "Prepare riboSeqR input"
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
41 can currently be tested using this workflow. Import this workflow into Galaxy.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
42
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
43 3. Run workflow
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
44
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
45 In Step 1 of the workflow, select "Prepare riboSeqR input (R data file)" as input.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
46
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
47 In Step 2, select rsem_chlamy236_deNovo.transcripts.fa as input.
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
48
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
49 Run workflow.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
50
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
51
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
52 About the test data files
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
53 .........................
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
54 The included "Prepare riboSeqR input (R data file)" is saved from an R session using sample data included with the
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
55 riboSeqR package. The commands used were ::
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
56
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
57 library(riboSeqR)
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
58
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
59 datadir <- system.file("extdata", package = "riboSeqR")
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
60 chlamyFasta <- paste(datadir, "/rsem_chlamy236_deNovo.transcripts.fa", sep = "")
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
61
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
62 fastaCDS <- findCDS(fastaFile = chlamyFasta, startCodon = c("ATG"), stopCodon = c("TAG", "TAA", "TGA"))
0
c34c364ce75d First commit
Vimalkumar Velayudhan <vimal@biotechcoder.com>
parents:
diff changeset
63
3
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
64 ribofiles <- paste(datadir, "/chlamy236_plus_deNovo_plusOnly_Index", c(17,3,5,7), sep = "")
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
65 rnafiles <- paste(datadir, "/chlamy236_plus_deNovo_plusOnly_Index", c(10,12,14,16), sep = "")
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
66
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
67 riboDat <- readRibodata(ribofiles, rnafiles, replicates = c("WT", "WT", "M", "M"))
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
68 save(riboDat, file="Prepare riboSeqR input (R data file)")
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
69
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
70 rsem_chlamy236_deNovo.transcripts.fa - sample data from the riboSeqR package.
d7ce95ccf54f Change R data file format in xml wrappers (rda -> RData)
Vimalkumar Velayudhan <vimalkumarvelayudhan@gmail.com>
parents: 0
diff changeset
71