Browse code

small clean-up

git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/SplicingGraphs@76877 bc3139a8-67e5-0310-9ffc-ced21a209358

Herve Pages authored on 24/05/2013 19:08:34
Showing 3 changed files

... ...
@@ -1,13 +1,14 @@
1 1
 Package: SplicingGraphs
2 2
 Title: Create, manipulate, visualize splicing graphs, and assign RNA-seq reads
3 3
 	to them
4
-Version: 1.1.10
4
+Version: 1.1.11
5 5
 Author: D. Bindreither, M. Carlson, M. Morgan, H. Pages
6 6
 License: Artistic-2.0
7 7
 Description: This package allows the user to create, manipulate, and visualize
8 8
 	splicing graphs and their bubbles based on a gene model for a given
9 9
 	organism. Additionally it allows the user to assign RNA-seq reads to
10
-	the edges of a set of splicing graphs, and to summarize them.
10
+	the edges of a set of splicing graphs, and to summarize them in
11
+        different ways.
11 12
 Maintainer: H. Pages <[email protected]>
12 13
 Depends: BiocGenerics,
13 14
 	 IRanges (>= 1.17.43), GenomicRanges (>= 1.13.5), GenomicFeatures,
... ...
@@ -1,4 +1,4 @@
1
-%\VignetteIndexEntry{Splicing graph analysis of RNA-Seq data}
1
+%\VignetteIndexEntry{Splicing graphs and RNA-seq data}
2 2
 %\VignetteDepends{SplicingGraphs,TxDb.Hsapiens.UCSC.hg19.knownGene,RNAseqData.HeLa.bam.chr14,Rsamtools}
3 3
 %\VignetteKeywords{Annotation}
4 4
 %\VignettePackage{SplicingGraphs}
... ...
@@ -32,7 +32,7 @@
32 32
 
33 33
 \SweaveOpts{keep.source=TRUE}
34 34
 
35
-\title{Splicing graph analysis of RNA-Seq data}
35
+\title{Splicing graphs and RNA-seq data}
36 36
 
37 37
 \author{Herv\'e Pag\`es\and
38 38
   Daniel Bindreither\and
... ...
@@ -103,24 +103,6 @@ HeLa cells (\textit{Human}).
103 103
 %\cite{Anders:2010}, the approach of analyzing splicing events as
104 104
 %complete complex structure is still new. 
105 105
 
106
-[TODO: Remove the following TEMPORARY NOTE before BioC 2.12 release.]
107
-
108
-TEMPORARY NOTE: The scope of the new \Rpackage{SplicingGraphs} package
109
-has been reduced roughly to the following functionalities:
110
-creating/manipulating/plotting splicing graphs, computing the bubbles
111
-and AS codes, and counting reads. In particular anything in the old
112
-\Rpackage{SpliceGraph} package that was related to the downstream
113
-statistical analysis has been dropped. As a consequence the following
114
-topics/sections from the old \Rpackage{SpliceGraph} vignette are not
115
-covered in this vignette:
116
-\begin{itemize}
117
-  \item ``The experimental design''
118
-  \item ``Significant altered alternative splice events''
119
-  \item Modification of GLM employed in the \Rpackage{DEXSeq} package.
120
-  \item ``Differential edge expression analysis''
121
-  \item Comparison to the classic \Rpackage{DEXSeq} analysis.
122
-\end{itemize}
123
- 
124 106
 
125 107
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
126 108
 \section{Splicing graphs}
... ...
@@ -12,11 +12,15 @@
12 12
   The \pkg{SplicingGraphs} package allows the user to create, manipulate,
13 13
   and visualize splicing graphs and their bubbles based on a gene model for
14 14
   a given organism. Additionally it allows the user to assign RNA-seq
15
-  reads to the edges of a set of splicing graphs, and to summarize them.
15
+  reads to the edges of a set of splicing graphs, and to summarize them in
16
+  different ways.
16 17
 }
17 18
 
18 19
 \details{
19
-  TODO
20
+  See the \emph{Splicing graphs and RNA-seq data} vignette in the package
21
+  for a gentle introduction to the \pkg{SplicingGraphs} package.
22
+  To access the vignette, do \code{browseVignettes("SplicingGraphs")}, then
23
+  click on the link to the PDF version.
20 24
 }
21 25
 
22 26
 \author{
... ...
@@ -32,6 +36,27 @@
32 36
   Maintainer: H. Pages <[email protected]>
33 37
 }
34 38
 
39
+\note{
40
+  With respect to the old \pkg{SpliceGraph} package, the scope of the new
41
+  \pkg{SplicingGraphs} package has been reduced roughly to the following
42
+  functionalities: creating/manipulating/plotting splicing graphs, computing
43
+  the bubbles and AS codes, and assigning/counting reads.
44
+
45
+  In addition to this, the old \pkg{SpliceGraph} package also had facilities
46
+  for performing some downstream statistical analysis. They were covered in
47
+  its vignette under the following topics/sections:
48
+  \itemize{
49
+    \item Experimental design
50
+    \item Significant altered alternative splice events
51
+    \item Modification of GLM employed in the \pkg{DEXSeq} package
52
+    \item Differential edge expression analysis
53
+    \item Comparison to the classic \pkg{DEXSeq} analysis
54
+  }
55
+  The \pkg{SplicingGraphs} vignette doesn't cover any of this and the
56
+  package provides no facilities for doing this type of downstream statistical
57
+  analysis. 
58
+}
59
+
35 60
 \references{
36 61
   Heber, S., Alekseyev, M., Sze, S., Tang, H., and Pevzner, P. A. 
37 62
   \emph{Splicing graphs and EST assembly problem}
... ...
@@ -84,4 +109,10 @@
84 109
   }
85 110
 }
86 111
 
112
+\examples{
113
+if (interactive()) {
114
+  ## Access the "Splicing graphs and RNA-seq data" vignette with:
115
+  browseVignettes("SplicingGraphs")
116
+}
117
+}
87 118
 \keyword{package}