Browse code

use Stream() for constructor, other code tidy

- Function* reset defaults to noop


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

Martin Morgan authored on 04/09/2012 21:07:34
Showing1 changed files
... ...
@@ -16,12 +16,14 @@
16 16
 
17 17
 \usage{
18 18
 reset(x, ...)
19
-\S4method{reset}{Streamer}(x, ...)
20 19
 }
21 20
 
22 21
 \arguments{
22
+
23 23
   \item{x}{A \code{Stream}, \code{Producer}, or \code{Consumer} object.}
24
+
24 25
   \item{\dots}{Additional arguments, currently unused.}
26
+
25 27
 }
26 28
 
27 29
 \value{
... ...
@@ -35,13 +37,13 @@ reset(x, ...)
35 37
 
36 38
 \seealso{
37 39
 
38
-  \code{\link{stream}}, \code{\linkS4class{Producer}},
40
+  \code{\link{Stream}}, \code{\linkS4class{Producer}},
39 41
   \code{\linkS4class{Consumer}}.
40 42
 
41 43
 }
42 44
 
43 45
 \examples{
44
-## see example(stream)
46
+## see example(Stream)
45 47
 }
46 48
 
47 49
 \keyword{methods}
Browse code

Code, documentation re-arrangment / standardization

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

Martin Morgan authored on 25/08/2012 22:59:04
Showing1 changed files
... ...
@@ -4,7 +4,7 @@
4 4
 \alias{reset-methods}
5 5
 \alias{reset,Streamer-method}
6 6
 
7
-\title{Reset a stream, or a stream component and all inputs.}
7
+\title{Function to reset a Stream, Producer, or Consumer}
8 8
 
9 9
 \description{
10 10
 
Browse code

Documentation and code tidy

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

Martin Morgan authored on 02/04/2011 22:30:43
Showing1 changed files
... ...
@@ -40,6 +40,8 @@ reset(x, ...)
40 40
 
41 41
 }
42 42
 
43
-\examples{}
43
+\examples{
44
+## see example(stream)
45
+}
44 46
 
45 47
 \keyword{methods}
Browse code

Add Streamer package

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

Martin Morgan authored on 15/03/2011 17:23:20
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,45 @@
1
+\name{reset}
2
+
3
+\alias{reset}
4
+\alias{reset-methods}
5
+\alias{reset,Streamer-method}
6
+
7
+\title{Reset a stream, or a stream component and all inputs.}
8
+
9
+\description{
10
+
11
+  \code{reset} on a stream invokes the \code{reset} method of all
12
+  components of the stream; on a component, it invokes the \code{reset}
13
+  method of the component and all inputs to the component.
14
+
15
+}
16
+
17
+\usage{
18
+reset(x, ...)
19
+\S4method{reset}{Streamer}(x, ...)
20
+}
21
+
22
+\arguments{
23
+  \item{x}{A \code{Stream}, \code{Producer}, or \code{Consumer} object.}
24
+  \item{\dots}{Additional arguments, currently unused.}
25
+}
26
+
27
+\value{
28
+
29
+  A reference to \code{x}, the stream or component on which \code{reset}
30
+  was invoked.
31
+
32
+}
33
+
34
+\author{Martin Morgan \url{mtmorgan@fhcrc.org}}
35
+
36
+\seealso{
37
+
38
+  \code{\link{stream}}, \code{\linkS4class{Producer}},
39
+  \code{\linkS4class{Consumer}}.
40
+
41
+}
42
+
43
+\examples{}
44
+
45
+\keyword{methods}