update readme

README.Rmd

@@ -38,18 +38,26 @@ devtools::install_github("pipeR","renkun-ken")
 
 The form of the object following `%>>%` determines which piping mechanism is used. If the operator is followed by, for example, 
 
-- `foo` or `foo(...)`: Pipe to its first argument;
-- `{ expr }` or `( expr )`: Pipe to symbol `.`;
-- `(x -> expr)` or `(x ~ expr)`: Pipe to symbol `x`.
+| Usage | As if |
+|-------|-------------|
+| `x %>>% f` | `f(x)` |
+| `x %>>% f(...)` | `f(x,...)` |
+| `x %>>% { f(.) }` | `f(x)` |
+| `x %>>% ( f(.) )` | `f(x)` |
+| `x %>>% (i -> f(i))` | `f(x)` |
+| `x %>>% (i ~ f(i))` | `f(x)` |
 
 ### `Pipe()`
 
 `Pipe()` creates a Pipe object that supports light-weight chaining using internal operators. For example,
 
-- `Pipe(x)$foo()$bar()`: Pipe along a chain of function calls and get a `Pipe` object for further chaining;
-- `Pipe(x)$foo()$bar() []`: Extract the final value of the `Pipe` object;
-- `Pipe(x)$fun(expr)`: Pipe to `.`;
-- `Pipe(x)$fun(x -> expr)` or `Pipe(x)$fun(x ~ expr)`: Pipe to `x`;
+| Usage | Description |
+|-------|-------|
+| `Pipe(x)$foo()$bar()` | Build `Pipe` object for chaining |
+| `Pipe(x)$foo()$bar() []` | Extract the final value |
+| `Pipe(x)$fun(expr)` | Pipe to `.` |
+| `Pipe(x)$fun(x -> expr)` | Pipe to `x` |
+| `Pipe(x)$fun(x ~ expr)` | Pipe to `x` |
 
 ## Examples
 

README.md

@@ -33,18 +33,26 @@ devtools::install_github("pipeR","renkun-ken")
 
 The form of the object following `%>>%` determines which piping mechanism is used. If the operator is followed by, for example, 
 
-- `foo` or `foo(...)`: Pipe to its first argument;
-- `{ expr }` or `( expr )`: Pipe to symbol `.`;
-- `(x -> expr)` or `(x ~ expr)`: Pipe to symbol `x`.
+| Usage | As if |
+|-------|-------------|
+| `x %>>% f` | `f(x)` |
+| `x %>>% f(...)` | `f(x,...)` |
+| `x %>>% { f(.) }` | `f(x)` |
+| `x %>>% ( f(.) )` | `f(x)` |
+| `x %>>% (i -> f(i))` | `f(x)` |
+| `x %>>% (i ~ f(i))` | `f(x)` |
 
 ### `Pipe()`
 
 `Pipe()` creates a Pipe object that supports light-weight chaining using internal operators. For example,
 
-- `Pipe(x)$foo()$bar()`: Pipe along a chain of function calls and get a `Pipe` object for further chaining;
-- `Pipe(x)$foo()$bar() []`: Extract the final value of the `Pipe` object;
-- `Pipe(x)$fun(expr)`: Pipe to `.`;
-- `Pipe(x)$fun(x -> expr)` or `Pipe(x)$fun(x ~ expr)`: Pipe to `x`;
+| Usage | Description |
+|-------|-------|
+| `Pipe(x)$foo()$bar()` | Build `Pipe` object for chaining |
+| `Pipe(x)$foo()$bar() []` | Extract the final value |
+| `Pipe(x)$fun(expr)` | Pipe to `.` |
+| `Pipe(x)$fun(x -> expr)` | Pipe to `x` |
+| `Pipe(x)$fun(x ~ expr)` | Pipe to `x` |
 
 ## Examples