1. Streamer
  2. man
  3. status.Rd
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
man/status.Rd
History View file @4464ce8
... ... 
@@ -15,6 +15,7 @@
15 15
16 16 
 \usage{
17 17 
 status(x, ...)
18 
+
18 19 
 \S4method{status}{Streamer}(x, ...)
19 20 
 }
20 21
... ... 
@@ -33,13 +34,13 @@ status(x, ...)
33 34
34 35 
 \seealso{
35 36
36 
-  \code{\link{stream}}, \code{\linkS4class{Producer}},
37 
+  \code{\link{Stream}}, \code{\linkS4class{Producer}},
37 38 
   \code{\linkS4class{Consumer}}.
38 39
39 40 
 }
40 41
41 42 
 \examples{
42 
-## see example(stream)
43 
+## see example(Stream)
43 44 
 }
44 45
45 46 
 \keyword{ manip }
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
man/status.Rd
History View file @5978aaa
... ... 
@@ -4,7 +4,7 @@
4 4 
 \alias{status-methods}
5 5 
 \alias{status,Streamer-method}
6 6
7 
-\title{Report current status of a stream.}
7 
+\title{Function to report current status of a stream}
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
man/status.Rd
History View file @3f24535
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,45 @@
1 
+\name{status}
2 
+
3 
+\alias{status}
4 
+\alias{status-methods}
5 
+\alias{status,Streamer-method}
6 
+
7 
+\title{Report current status of a stream.}
8 
+
9 
+\description{
10 
+
11 
+  \code{status} invoked on a stream yields the current status of the
12 
+  stream, as reported by the \code{status} methods of each component.
13 
+
14 
+}
15 
+
16 
+\usage{
17 
+status(x, ...)
18 
+\S4method{status}{Streamer}(x, ...)
19 
+}
20 
+
21 
+\arguments{
22 
+  \item{x}{A \code{Stream}, \code{Producer}, or \code{Consumer} object.}
23 
+  \item{\dots}{Additional arguments, currently unused.}
24 
+}
25 
+
26 
+\value{
27 
+
28 
+  A component-specific summary the current status
29 
+
30 
+}
31 
+
32 
+\author{Martin Morgan \url{mtmorgan@fhcrc.org}}
33 
+
34 
+\seealso{
35 
+
36 
+  \code{\link{stream}}, \code{\linkS4class{Producer}},
37 
+  \code{\linkS4class{Consumer}}.
38 
+
39 
+}
40 
+
41 
+\examples{
42 
+## see example(stream)
43 
+}
44 
+
45 
+\keyword{ manip }