Further improve document; fix bug when a method matches all possible prefixes.

Jonathan Chang · Jonathan Chang · commit 283b728d292d · 2011-07-25T16:35:56.000-07:00
diff --git a/pkg/R/Rpipe.R b/pkg/R/Rpipe.R
@@ -58,7 +58,7 @@ Rpipe.eval <- function(e1, expr) {
                     envir = as.environment(-1),
                     ifnotfound = list(NULL),
                     inherits = TRUE)
-    func.names <- lookups[-which(sapply(lookups, is.null))]
+    func.names <- which(sapply(lookups, function(x) !is.null(x)))
     if (length(func.names) == 0) {
       stop(paste("Could not find pipe function", expr[1]))
     }
diff --git a/pkg/man/Rpipe.Rd b/pkg/man/Rpipe.Rd
@@ -4,36 +4,29 @@
   Manipulate a data frame through a series of pipe operations.
 }
 \description{
-  
+  This provides an alternative syntax for calling a series of operations successively on data frames.  Rather than nesting/composing function calls, this implements a pipe operator similar to that in command shells.  This allows users to generate data frames by applying stages of data frame operations one after the other. 
 }
 \usage{
 df %|% operation()
 }
 \arguments{
   \item{df}{
     A data frame to operate on.  Note that this can be the output of another \code{Rpipe} stage.}
-  \item{e2}{
-%%     ~~Describe \code{e2} here~~
+  \item{operation}{
+  Any function call which takes a data frame and returns a data frame.  Note that in addition to typical operations such as subset, this package also makes available/changes the semantics of \code{group}, \code{aggregate}, and \code{sort}.
 }
 }
-\details{
-%%  ~~ If necessary, more details than the description above ~~
-}
 \value{
-%%  ~Describe the value returned
-%%  If it is a LIST, use
-%%  \item{comp1 }{Description of 'comp1'}
-%%  \item{comp2 }{Description of 'comp2'}
-%% ...
+  A data frame resulting from calling \code{operation} with \code{df} inserted as the first argument.
 }
 \author{
   Jonathan Chang <jonchang@fb.com>
 }
 
 \examples{
-iris %|%
-  subset(Sepal.Width > 3.0) %|%
-    sort(Sepal.Length) %|%
-      group(Species, head()) %|%
-        aggregate(Species, Mean.Petal.Width = mean(Petal.Width))
+iris \%|\% 
+  subset(Sepal.Width > 3.0) \%|\% 
+  sort(Sepal.Length) \%|\% 
+  group(Species, head()) \%|\% 
+  aggregate(Species, Mean.Petal.Width = mean(Petal.Width))
 }

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ Rpipe.eval <- function(e1, expr) {`
`58`	`58`	`envir = as.environment(-1),`
`59`	`59`	`ifnotfound = list(NULL),`
`60`	`60`	`inherits = TRUE)`
`61`		`- func.names <- lookups[-which(sapply(lookups, is.null))]`
	`61`	`+ func.names <- which(sapply(lookups, function(x) !is.null(x)))`
`62`	`62`	`if (length(func.names) == 0) {`
`63`	`63`	`stop(paste("Could not find pipe function", expr[1]))`
`64`	`64`	`}`