add .() doc

rebuild recheck

Author: JohnMount

DESCRIPTION

@@ -2,7 +2,7 @@ Package: wrapr
 Type: Package
 Title: Wrap R Tools for Debugging and Parametric Programming
 Version: 1.9.1
-Date: 2019-09-29
+Date: 2019-10-04
 Authors@R: c(
     person("John", "Mount", email = "[email protected]", role = c("aut", "cre")),
     person("Nina", "Zumel", email = "[email protected]", role = c("aut")),

NEWS.md

@@ -1,7 +1,8 @@
 
-# wrapr 1.9.1 2019-09-29
+# wrapr 1.9.1 2019-10-04
 
  * Fix locum composite line printing.
+ * Document .()-escaping in pipe.
 
 # wrapr 1.9.0 2019-09-28
 

R/bpipe.R

@@ -490,6 +490,11 @@ pipe_impl <- function(pipe_left_arg,
 #' For a base-R step-debuggable pipe please try the Bizarro Pipe \url{http://www.win-vector.com/blog/2017/01/using-the-bizarro-pipe-to-debug-magrittr-pipelines-in-r/}.
 #' \code{\%>.\%} and \code{\%.>\%} are synonyms.
 #'
+#' The dot arrow pipe has S3/S4 dispatch (please see \url{https://journal.r-project.org/archive/2018/RJ-2018-042/index.html}).
+#' However as the right-hand side of the pipe is normally held unevaluated, we don't know the type except in special
+#' cases (such as the rigth-hand side being referred to by a name or variable).  To force the evaluation of a pipe term,
+#' simply wrap it in .().
+#'
 #' @param pipe_left_arg left argument expression (substituted into .)
 #' @param pipe_right_arg right argument expression (presumably including .)
 #' @return eval(\{ . <- pipe_left_arg; pipe_right_arg \};)

README.Rmd

@@ -145,6 +145,10 @@ are treated performed (example: `5 %.>% base::sin(.)`).</li>
 <li>Outer parenthesis on the right-hand side are removed (example: `5 %.>% (sin(.))`).</li>
 <li>Anonymous function constructions are evaluated so the function can be applied (example: `5 %.>% function(x) {x+1}` returns 6, just as `5 %.>% (function(x) {x+1})(.)` does).</li>
 <li>Checks and transforms are not performed on items inside braces (example: `5 %.>% { function(x) {x+1} }` returns `function(x) {x+1}`, not 6).</li>
+<li>The dot arrow pipe has S3/S4 dispatch (please see \url{https://journal.r-project.org/archive/2018/RJ-2018-042/index.html}).
+However as the right-hand side of the pipe is normally held unevaluated, we don't know the type except in special
+cases (such as the rigth-hand side being referred to by a name or variable).  To force the evaluation of a pipe term,
+simply wrap it in `.()`.</li>
 </ul>
 
 The dot pipe is also user configurable through standard `S3`/`S4` methods.

cran-comments.md

@@ -6,35 +6,23 @@
 ### Windows
 
     rhub::check_for_cran()
-    507#> * using R Under development (unstable) (2019-09-18 r77193)
-    508#> * using platform: x86_64-w64-mingw32 (64-bit)
-    509#> * using session charset: ISO8859-1
-    510#> * using option '--as-cran'
-    511#> * checking for file 'wrapr/DESCRIPTION' ... OK
-    512#> * checking extension type ... Package
-    513#> * this is package 'wrapr' version '1.9.0'
-    514#> * package encoding: UTF-8
-    515#> * checking CRAN incoming feasibility ... Note_to_CRAN_maintainers
-    516#> Maintainer: 'John Mount '
-    558#> * checking sizes of PDF files under 'inst/doc' ... NOTE
-    559#> Unable to find GhostScript executable to run checks on size reduction
-    574#> Status: 1 NOTE
     Note: is property of the check installation, not the package.
 
 ### MacOS
 
-    R CMD check --as-cran wrapr_1.9.0.tar.gz
+    R CMD check --as-cran wrapr_1.9.1.tar.gz 
     * using R version 3.6.0 (2019-04-26)
     * using platform: x86_64-apple-darwin15.6.0 (64-bit)
     * using session charset: UTF-8
     * using option ‘--as-cran’
     * checking for file ‘wrapr/DESCRIPTION’ ... OK
     * checking extension type ... Package
-    * this is package ‘wrapr’ version ‘1.9.0’
+    * this is package ‘wrapr’ version ‘1.9.1’
     * package encoding: UTF-8
-    * checking CRAN incoming feasibility ... Note_to_CRAN_maintainers
+    * checking CRAN incoming feasibility ... NOTE
     Maintainer: ‘John Mount <[email protected]>’
-    Status: OK
+    Days since last update: 6
+    Status: 1 NOTE
 
 ## Downstream dependencies