export dotify; update docs

DESCRIPTION

@@ -2,7 +2,8 @@ Package: dotty
 Type: Package
 Title: The Unpacking Dot Operator
 Version: 0.1.0.9000
-Authors@R: c(
+Authors@R:
+  c(
     person(
       "Kevin", "Ushey",
       email = "[email protected]",

NAMESPACE

@@ -7,6 +7,7 @@ S3method(format,dotty)
 S3method(print,dotty)
 export(.)
 export(destructure)
+export(dotify)
 importFrom(utils,globalVariables)
 importFrom(utils,head)
 importFrom(utils,tail)

NEWS.md

@@ -1,6 +1,9 @@
 
 # dotty 0.2.0  (UNRELEASED)
 
+- `dotty::dotify()` is now exported for use by R packages which would
+  like to use `dotty` internally. (#1)
+
 
 # dotty 0.1.0
 

R/destructure.R

@@ -1,16 +1,17 @@
 
 #' Destructure an Object
-#' 
+#'
 #' `destructure` is primarily used to help define how an
 #' object should be prepared, or transformed, prior to a
 #' destructuring assignment. This can be relevant for
 #' objects which have unique subsetting semantics -- for
 #' example, [numeric_version] objects.
-#' 
+#'
 #' Packages which would like to define special destructring
 #' semantics for certain object classes can implement
 #' methods for this class.
-#' 
+#'
+#' @param object An \R object.
 #' @export
 destructure <- function(object) {
   UseMethod("destructure")

R/dotify.R

@@ -1,8 +1,25 @@
 
-`%||%` <- function(x, y) {
-  if (is.null(x)) y else x
-}
-
+#' Dotify an R Package
+#'
+#' When using `dotty` within an R package, you might see **NOTE**s during
+#' `R CMD check` of the form:
+#'
+#' ```
+#' N  checking R code for possible problems (1.8s)
+#'    <package>: no visible binding for global variable <variable>
+#'    Undefined global functions or variables:
+#'      <variable>
+#' ```
+#'
+#' This occurs because the [codetools] package, which is used for static
+#' analysis of \R code during `R CMD check`, does not recognize that e.g.
+#' `.[apple] <- 42` would create a variable called `apple` in the current
+#' scope. Calling `dotty::dotify()` in your package's `.onLoad()` will
+#' allow `dotty` to patch `codetools` in a way that will allow it to
+#' understand `dotty` usages, and so prevent these `R CMD check` notes
+#' from being emitted.
+#'
+#' @export
 dotify <- function() {
 
   # allow us to be disabled if necessary

R/utils.R

@@ -0,0 +1,4 @@
+
+`%||%` <- function(x, y) {
+  if (is.null(x)) y else x
+}