git-svn-id: file:///home/git/hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/SplicingGraphs@76137 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -1,5 +1,6 @@ |
1 | 1 |
Package: SplicingGraphs |
2 |
-Title: Creation, manipulation, visualization of splicing graphs |
|
2 |
+Title: Create, manipulate, visualize splicing graphs, and assign RNA-seq reads |
|
3 |
+ to them |
|
3 | 4 |
Version: 1.1.8 |
4 | 5 |
Author: D. Bindreither, M. Carlson, M. Morgan, H. Pages |
5 | 6 |
License: Artistic-2.0 |
... | ... |
@@ -207,22 +207,22 @@ SplicingGraphs(x, grouping=NULL, min.ntx=2, max.ntx=NA, check.introns=TRUE) |
207 | 207 |
} |
208 | 208 |
|
209 | 209 |
\seealso{ |
210 |
- This man page is part of the SplicingGraphs package. |
|
210 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
211 | 211 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
212 | 212 |
package and for an index of its man pages. |
213 | 213 |
|
214 | 214 |
Other topics related to this man page and documented in other packages: |
215 | 215 |
\itemize{ |
216 | 216 |
\item The \code{\link[GenomicFeatures]{exonsBy}} and |
217 |
- \code{\link[GenomicFeatures]{transcriptsBy}} functions, and the |
|
218 |
- \link[GenomicFeatures]{TranscriptDb} class in the GenomicFeatures |
|
219 |
- package. |
|
217 |
+ \code{\link[GenomicFeatures]{transcriptsBy}} functions, and |
|
218 |
+ the \link[GenomicFeatures]{TranscriptDb} class in the |
|
219 |
+ \pkg{GenomicFeatures} package. |
|
220 | 220 |
|
221 |
- \item The \link[GenomicRanges]{GRangesList} class in the GenomicRanges |
|
222 |
- package. |
|
221 |
+ \item The \link[GenomicRanges]{GRangesList} class in the |
|
222 |
+ \pkg{GenomicRanges} package. |
|
223 | 223 |
|
224 | 224 |
\item The \link[IRanges]{IntegerList}, \link[IRanges]{CharacterList}, |
225 |
- and \link[IRanges]{DataFrame} classes in the IRanges package. |
|
225 |
+ and \link[IRanges]{DataFrame} classes in the \pkg{IRanges} package. |
|
226 | 226 |
} |
227 | 227 |
} |
228 | 228 |
|
... | ... |
@@ -4,12 +4,13 @@ |
4 | 4 |
\alias{SplicingGraphs-package} |
5 | 5 |
|
6 | 6 |
\title{ |
7 |
- Creation, manipulation, visualization of splicing graphs |
|
7 |
+ Create, manipulate, visualize splicing graphs, and assign RNA-seq reads |
|
8 |
+ to them |
|
8 | 9 |
} |
9 | 10 |
|
10 | 11 |
\description{ |
11 |
- The SplicingGraphs package allows the user to create, manipulate, and |
|
12 |
- visualize splicing graphs and their bubbles based on a gene model for |
|
12 |
+ The \pkg{SplicingGraphs} package allows the user to create, manipulate, |
|
13 |
+ and visualize splicing graphs and their bubbles based on a gene model for |
|
13 | 14 |
a given organism. Additionally it allows the user to assign RNA-seq |
14 | 15 |
reads to the edges of a set of splicing graphs, and to summarize them. |
15 | 16 |
} |
... | ... |
@@ -19,12 +20,14 @@ |
19 | 20 |
} |
20 | 21 |
|
21 | 22 |
\author{ |
22 |
- SplicingGraphs is a reincarnation of an internal project, the SpliceGraph |
|
23 |
- package, originally written by D. Bindreither, M. Carlson, and M. Morgan. |
|
24 |
- The SpliceGraph package was never released as part of Bioconductor. |
|
23 |
+ \pkg{SplicingGraphs} is a reincarnation of an internal project, the |
|
24 |
+ \pkg{SpliceGraph} package, originally written by D. Bindreither, |
|
25 |
+ M. Carlson, and M. Morgan. |
|
26 |
+ The \pkg{SpliceGraph} package was never released as part of Bioconductor. |
|
25 | 27 |
|
26 |
- The SplicingGraphs package is a complete revamp (design and implementation) |
|
27 |
- of the SpliceGraph package, and was written by H. Pages. |
|
28 |
+ The \pkg{SplicingGraphs} package is a complete revamp (design and |
|
29 |
+ implementation) of the \pkg{SpliceGraph} package, and was written by |
|
30 |
+ H. Pages. |
|
28 | 31 |
|
29 | 32 |
Maintainer: H. Pages <[email protected]> |
30 | 33 |
} |
... | ... |
@@ -46,7 +49,7 @@ |
46 | 49 |
} |
47 | 50 |
|
48 | 51 |
\seealso{ |
49 |
- The man pages in the SplicingGraphs package are: |
|
52 |
+ The man pages in the \pkg{SplicingGraphs} package are: |
|
50 | 53 |
\enumerate{ |
51 | 54 |
\item The \link{SplicingGraphs} class. |
52 | 55 |
|
... | ... |
@@ -65,8 +65,8 @@ removeReads(sg) |
65 | 65 |
|
66 | 66 |
If (a): you can find out whether reads in a BAM file are single- or |
67 | 67 |
paired-end with the \code{\link[Rsamtools]{quickCountBam}} utility |
68 |
- from the Rsamtools package. If they're paired-end, load them with |
|
69 |
- \code{\link[GenomicRanges]{readGAlignmentPairs}} |
|
68 |
+ from the \pkg{Rsamtools} package. If they're paired-end, load them |
|
69 |
+ with \code{\link[GenomicRanges]{readGAlignmentPairs}} |
|
70 | 70 |
instead of \code{\link[GenomicRanges]{readGAlignments}}, and that |
71 | 71 |
will pair them. |
72 | 72 |
|
... | ... |
@@ -84,7 +84,7 @@ removeReads(sg) |
84 | 84 |
param=param0) |
85 | 85 |
} |
86 | 86 |
This will filter out records that have flag 0x100 (secondary alignment) |
87 |
- set to 1. See \code{?\link[Rsamtools]{scanBamFlag}} in the Rsamtools |
|
87 |
+ set to 1. See \code{?\link[Rsamtools]{scanBamFlag}} in the \pkg{Rsamtools} |
|
88 | 88 |
package for more information. |
89 | 89 |
See the SAM Specs on the SAMtools project page at |
90 | 90 |
\url{http://samtools.sourceforge.net/} for a description of the |
... | ... |
@@ -104,7 +104,7 @@ removeReads(sg) |
104 | 104 |
} |
105 | 105 |
|
106 | 106 |
\seealso{ |
107 |
- This man page is part of the SplicingGraphs package. |
|
107 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
108 | 108 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
109 | 109 |
package and for an index of its man pages. |
110 | 110 |
|
... | ... |
@@ -113,11 +113,11 @@ removeReads(sg) |
113 | 113 |
\item The \link[GenomicRanges]{GRangesList}, |
114 | 114 |
\link[GenomicRanges]{GAlignments}, and |
115 | 115 |
\link[GenomicRanges]{GAlignmentPairs} classes |
116 |
- in the GenomicRanges package. |
|
116 |
+ in the \pkg{GenomicRanges} package. |
|
117 | 117 |
|
118 | 118 |
\item The \code{\link[Rsamtools]{quickCountBam}} and |
119 | 119 |
\code{\link[Rsamtools]{ScanBamParam}} functions in the |
120 |
- Rsamtools package. |
|
120 |
+ \pkg{Rsamtools} package. |
|
121 | 121 |
} |
122 | 122 |
} |
123 | 123 |
|
... | ... |
@@ -44,7 +44,7 @@ ASCODE2DESC |
44 | 44 |
} |
45 | 45 |
|
46 | 46 |
\seealso{ |
47 |
- This man page is part of the SplicingGraphs package. |
|
47 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
48 | 48 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
49 | 49 |
package and for an index of its man pages. |
50 | 50 |
} |
... | ... |
@@ -151,7 +151,7 @@ reportReads(x, by=c("sgedge", "rsgedge", "tx", "gene")) |
151 | 151 |
} |
152 | 152 |
|
153 | 153 |
\seealso{ |
154 |
- This man page is part of the SplicingGraphs package. |
|
154 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
155 | 155 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
156 | 156 |
package and for an index of its man pages. |
157 | 157 |
} |
... | ... |
@@ -13,8 +13,8 @@ |
13 | 13 |
} |
14 | 14 |
|
15 | 15 |
\description{ |
16 |
- \code{plotTranscripts} uses the Gviz package to plot the exon structure |
|
17 |
- of a set of transcripts along genomic coordinates. |
|
16 |
+ \code{plotTranscripts} uses the \pkg{Gviz} package to plot the exon |
|
17 |
+ structure of a set of transcripts along genomic coordinates. |
|
18 | 18 |
} |
19 | 19 |
|
20 | 20 |
\usage{ |
... | ... |
@@ -47,22 +47,22 @@ plotTranscripts(x, reads=NULL, from=NA, to=NA) |
47 | 47 |
} |
48 | 48 |
|
49 | 49 |
\seealso{ |
50 |
- This man page is part of the SplicingGraphs package. |
|
50 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
51 | 51 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
52 | 52 |
package and for an index of its man pages. |
53 | 53 |
|
54 | 54 |
Other topics related to this man page and documented in other packages: |
55 | 55 |
\itemize{ |
56 |
- \item The \code{\link[Gviz]{plotTracks}} function in the Gviz package |
|
57 |
- that \code{plotTranscripts} is based on. |
|
56 |
+ \item The \code{\link[Gviz]{plotTracks}} function in the \pkg{Gviz} |
|
57 |
+ package that \code{plotTranscripts} is based on. |
|
58 | 58 |
|
59 | 59 |
\item The \link[GenomicRanges]{GRangesList}, |
60 | 60 |
\link[GenomicRanges]{GAlignments}, and |
61 | 61 |
\link[GenomicRanges]{GAlignmentPairs} classes |
62 |
- in the GenomicRanges package. |
|
62 |
+ in the \pkg{GenomicRanges} package. |
|
63 | 63 |
|
64 |
- \item The \link[GenomicFeatures]{TranscriptDb} class in the GenomicFeatures |
|
65 |
- package. |
|
64 |
+ \item The \link[GenomicFeatures]{TranscriptDb} class in the |
|
65 |
+ \pkg{GenomicFeatures} package. |
|
66 | 66 |
} |
67 | 67 |
} |
68 | 68 |
|
... | ... |
@@ -90,7 +90,7 @@ uninformativeSSids(x) |
90 | 90 |
} |
91 | 91 |
|
92 | 92 |
\seealso{ |
93 |
- This man page is part of the SplicingGraphs package. |
|
93 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
94 | 94 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
95 | 95 |
package and for an index of its man pages. |
96 | 96 |
} |
... | ... |
@@ -63,7 +63,7 @@ indeg(x) |
63 | 63 |
} |
64 | 64 |
|
65 | 65 |
\seealso{ |
66 |
- This man page is part of the SplicingGraphs package. |
|
66 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
67 | 67 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
68 | 68 |
package and for an index of its man pages. |
69 | 69 |
} |
... | ... |
@@ -86,7 +86,7 @@ sgedgesByTranscript(x, with.exon.mcols=FALSE, with.hits.mcols=FALSE) |
86 | 86 |
} |
87 | 87 |
|
88 | 88 |
\seealso{ |
89 |
- This man page is part of the SplicingGraphs package. |
|
89 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
90 | 90 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
91 | 91 |
package and for an index of its man pages. |
92 | 92 |
} |
... | ... |
@@ -68,7 +68,7 @@ slideshow(x) |
68 | 68 |
} |
69 | 69 |
|
70 | 70 |
\seealso{ |
71 |
- This man page is part of the SplicingGraphs package. |
|
71 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
72 | 72 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
73 | 73 |
package and for an index of its man pages. |
74 | 74 |
} |
... | ... |
@@ -8,7 +8,7 @@ |
8 | 8 |
|
9 | 9 |
\title{ |
10 | 10 |
Little helpers for quick access to the toy data included in the |
11 |
- SplicingGraphs package |
|
11 |
+ \pkg{SplicingGraphs} package |
|
12 | 12 |
} |
13 | 13 |
|
14 | 14 |
\description{ |
... | ... |
@@ -27,7 +27,7 @@ toy_overlaps() |
27 | 27 |
} |
28 | 28 |
|
29 | 29 |
\seealso{ |
30 |
- This man page is part of the SplicingGraphs package. |
|
30 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
31 | 31 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
32 | 32 |
package and for an index of its man pages. |
33 | 33 |
|
... | ... |
@@ -36,11 +36,11 @@ toy_overlaps() |
36 | 36 |
\item The \link[GenomicRanges]{GRangesList}, |
37 | 37 |
\link[GenomicRanges]{GAlignments}, and |
38 | 38 |
\link[GenomicRanges]{GAlignmentPairs} classes |
39 |
- in the GenomicRanges package. |
|
39 |
+ in the \pkg{GenomicRanges} package. |
|
40 | 40 |
|
41 | 41 |
\item The \code{\link[GenomicFeatures]{makeTranscriptDbFromGFF}} |
42 | 42 |
function and the \link[GenomicFeatures]{TranscriptDb} class |
43 |
- in the GenomicFeatures package. |
|
43 |
+ in the \pkg{GenomicFeatures} package. |
|
44 | 44 |
} |
45 | 45 |
} |
46 | 46 |
|
... | ... |
@@ -60,7 +60,7 @@ txweight(x) <- value |
60 | 60 |
} |
61 | 61 |
|
62 | 62 |
\seealso{ |
63 |
- This man page is part of the SplicingGraphs package. |
|
63 |
+ This man page is part of the \pkg{SplicingGraphs} package. |
|
64 | 64 |
Please see \code{?`\link{SplicingGraphs-package}`} for an overview of the |
65 | 65 |
package and for an index of its man pages. |
66 | 66 |
|
... | ... |
@@ -69,14 +69,14 @@ txweight(x) <- value |
69 | 69 |
\item The \link[GenomicRanges]{GRangesList}, |
70 | 70 |
\link[GenomicRanges]{GAlignments}, and |
71 | 71 |
\link[GenomicRanges]{GAlignmentPairs} classes |
72 |
- in the GenomicRanges package. |
|
72 |
+ in the \pkg{GenomicRanges} package. |
|
73 | 73 |
|
74 | 74 |
\item \link[GenomicRanges]{findOverlaps-methods} and |
75 | 75 |
\link[GenomicRanges]{encodeOverlaps-methods} in the |
76 |
- GenomicRanges package. |
|
76 |
+ \pkg{GenomicRanges} package. |
|
77 | 77 |
|
78 | 78 |
\item The \code{\link[Rsamtools]{ScanBamParam}} function in the |
79 |
- Rsamtools package. |
|
79 |
+ \pkg{Rsamtools} package. |
|
80 | 80 |
} |
81 | 81 |
} |
82 | 82 |
|