1. Streamer
  2. man
  3. yield.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/yield.Rd
History View file @4464ce8
... ... 
@@ -16,12 +16,14 @@
16 16
17 17 
 \usage{
18 18 
 yield(x, ...)
19 
-\S4method{yield}{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 @@ yield(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{ manip }
Browse code

add ParallelParam class, Team generic & methods; doc tweaks

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

Martin Morgan authored on 27/08/2012 01:49:07
Showing1 changed files
man/yield.Rd
History View file @6744af8
... ... 
@@ -4,7 +4,7 @@
4 4 
 \alias{yield-methods}
5 5 
 \alias{yield,Streamer-method}
6 6
7 
-\title{Function to yield one chunk of data}
7 
+\title{Function to yield one task from a Stream or Producer}
8 8
9 9 
 \description{
10 10
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/yield.Rd
History View file @5978aaa
... ... 
@@ -4,7 +4,7 @@
4 4 
 \alias{yield-methods}
5 5 
 \alias{yield,Streamer-method}
6 6
7 
-\title{Iterate a stream to yield one chunk of data.}
7 
+\title{Function to yield one chunk of data}
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/yield.Rd
History View file @3f24535
... ... 
@@ -40,6 +40,8 @@ yield(x, ...)
40 40
41 41 
 }
42 42
43 
-\examples{}
43 
+\examples{
44 
+## see example(stream)
45 
+}
44 46
45 47 
 \keyword{ manip }
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
man/yield.Rd
History View file @b066119
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,45 @@
1 
+\name{yield}
2 
+
3 
+\alias{yield}
4 
+\alias{yield-methods}
5 
+\alias{yield,Streamer-method}
6 
+
7 
+\title{Iterate a stream to yield one chunk of data.}
8 
+
9 
+\description{
10 
+
11 
+  \code{yield} invoked on a stream yields one chunk of data or, if the
12 
+  stream is complete, a length zero element of the data. Successive
13 
+  invocations of \code{yield} produce successive chunks of data.
14 
+
15 
+}
16 
+
17 
+\usage{
18 
+yield(x, ...)
19 
+\S4method{yield}{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 chunk of data, with the specific notion of chunk defined by the
30 
+  final component of the stream.
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{ manip }