Tidy Tools for Making and Combining Functions
Branch: master
Clone or download
Latest commit 58e0078 Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
inst On CRAN Nov 6, 2018
man
tests
vignettes Incorporate updates from README Jul 9, 2018
.Rbuildignore
.gitignore Ignore notes Nov 11, 2018
.travis.yml
DESCRIPTION
LICENSE
NAMESPACE Context names Aug 8, 2018
NEWS.md Update NEWS Feb 10, 2019
README.Rmd
README.md Omit adjective Jul 9, 2018
codecov.yml
gestalt.Rproj

README.md

Travis-CI Build Status codecov CRAN_Status_Badge

gestalt

The gestalt package provides a function composition operator, %>>>%, which improves the clarity, modularity, and versatility of your functions by enabling you to:

More importantly, gestalt fosters a powerful way of thinking about values as functions.

Overview

The following example (adapted from purrr) illustrates the use of %>>>% to express a function that takes the name of a factor-column of the mtcars data frame, fits a linear model to the corresponding groups, then computes the R² of the summary.

library(gestalt)

fit <- mpg ~ wt

r2 <- {split(mtcars, mtcars[[.]])} %>>>%
  lapply(function(data) lm(!!fit, data)) %>>>%
  summarize: (
    lapply(summary) %>>>%
      stat: sapply(`[[`, "r.squared")
  )

r2("cyl")
#>         4         6         8 
#> 0.5086326 0.4645102 0.4229655

gestalt leverages the ubiquity of the magrittr %>% operator, by adopting its semantics and augmenting it to enable you to:

  • Clarify intent by annotating constituent functions with descriptive names, which also serve as subsetting references

  • Express nested sub-compositions, while nonetheless preserving the runtime characteristics of a flattened composition, so you can focus on expressing structure that is most natural for your function

  • Unquote sub-expressions with the tidyverse !! operator, to enforce immutability or spare a runtime computation

Ceci n’est pas une %>%

Despite the syntactic similarity, the %>>>% operator is conceptually distinct from the magrittr %>% operator. Whereas %>% “pipes” a value into a function to yield a value, %>>>% composes functions to yield a function.

The most significant distinction, however, is that list idioms apply to composite functions made by %>>>%, so that you can inspect, modify, and repurpose them, intuitively.

Select segments of functions using indexing

To select the first two functions in r2, in order to get the fitted model, index with the vector 1:2:

r2[1:2]("cyl")[["6"]]  # Cars with 6 cylinders
#> 
#> Call:
#> lm(formula = mpg ~ wt, data = data)
#> 
#> Coefficients:
#> (Intercept)           wt  
#>       28.41        -2.78

Repurpose using subset-assignment

To compute the residuals rather than the R², reassign the summary-statistic function:

residuals <- r2
residuals$summarize$stat <- function(s) sapply(s, `[[`, "residuals")
residuals("cyl")[["6"]]
#>      Mazda RX4  Mazda RX4 Wag Hornet 4 Drive        Valiant       Merc 280 
#>     -0.1249670      0.5839601      1.9291961     -0.6896780      0.3547199 
#>      Merc 280C   Ferrari Dino 
#>     -1.0452801     -1.0079511

Inspect or modify using higher-order functions

Consider a function that capitalizes and joins a random selection of characters:

scramble <- sample %>>>% toupper %>>>% paste(collapse = "")

set.seed(1)
scramble(letters, 5)
#> [1] "GJNUE"

Here you see the final result of the composition. But because scramble is a list-like object, you can also inspect its intermediate steps by applying a standard “map-reduce” strategy, such as the following higher-order function:

stepwise <- lapply(`%>>>%`, print) %>>>% compose

stepwise maps over the constituent functions of a composite function to add printing at each step:

set.seed(1)
stepwise(scramble)(letters, 5)
#> [1] "g" "j" "n" "u" "e"
#> [1] "G" "J" "N" "U" "E"
#> [1] "GJNUE"

The value of values as functions

Whenever you have a value that results from a series of piped values, such as

library(magrittr)

mtcars %>% 
  split(.$cyl) %>% 
  lapply(function(data) lm(mpg ~ wt, data)) %>% 
  lapply(summary) %>% 
  sapply(`[[`, "r.squared")
#>         4         6         8 
#> 0.5086326 0.4645102 0.4229655

you can transpose it to a constant composite function that computes the same value, simply by treating the input value as a constant function and replacing each function application, %>%, by function composition, %>>>%:

R2 <- {mtcars} %>>>% 
  split(.$cyl) %>>>%
  lapply(function(data) lm(mpg ~ wt, data)) %>>>%
  lapply(summary) %>>>%
  sapply(`[[`, "r.squared")

You gain power by treating (piped) values as (composite) functions:

  1. Values as functions are lazy. You can separate the value’s declaration from its point of use—the value is only computed on demand:

    R2()
    #>         4         6         8 
    #> 0.5086326 0.4645102 0.4229655
  2. Values as functions are cheap. You can cache the value of R2 by declaring it as a constant:

    R2 <- constant(R2)
    R2()
    #>         4         6         8 
    #> 0.5086326 0.4645102 0.4229655
    
    # On a 2016 vintage laptop
    microbenchmark::microbenchmark(R2(), times = 1e6)  
    #> Unit: nanoseconds
    #>  expr min  lq     mean median  uq      max neval
    #>  R2() 532 567 709.1435    585 647 39887308 1e+06
  3. Values as functions encode their computation. Since a composite function qua computation is a list-like object, you can compute on it to extract latent information.

    For instance, you can get the normal Q–Q plot of the fitted model for 6-cylinder cars from the head of R2:

    head(R2, 3)() %>% .[["6"]] %>% plot(2)

Complements

In conjunction with %>>>%, gestalt also provides:

  • fn, a more concise and flexible variation of function, which supports tidyverse quasiquotation.

    size <- 5L
    
    fn(x, ... ~ sample(x, !!size, ...))
    #> function (x, ...) 
    #> sample(x, 5L, ...)
  • partial, to make new functions from old by fixing a number of arguments, i.e., partial application. Like fn, it also supports quasiquotation.

    (draw <- partial(sample, size = !!size, replace = TRUE))
    #> <Partially Applied Function>
    #> 
    #> function(x, prob = NULL) {
    #>   sample(x = x, size = ^5L, replace = ^TRUE, prob = prob)
    #> }
    #> 
    #> Recover the inner function with 'departial()'.
    
    set.seed(2)
    draw(letters)
    #> [1] "e" "s" "o" "e" "y"

    Additionally, partial is:

    • Hygenic: The fixed argument values are tidily evaluated promises; in particular, the usual lazy behavior of function arguments, which can be overridden via unquoting, is respected even for fixed arguments.

    • Flat: Fixing arguments in stages is operationally equivalent to fixing them all at once—you get the same function either way:

      partial(partial(sample, replace = TRUE), size = 5L)
      #> <Partially Applied Function>
      #> 
      #> function(x, prob = NULL) {
      #>   sample(x = x, size = ^5L, replace = ^TRUE, prob = prob)
      #> }
      #> 
      #> Recover the inner function with 'departial()'.

See the package documentation for more details (help(package = gestalt)).

Installation

Install from CRAN:

install.packages("gestalt")

Alternatively, install the development version from GitHub:

# install.packages("devtools")
devtools::install_github("egnha/gestalt", build_vignettes = TRUE)

Acknowledgments

  • The core semantics of %>>>% conform to those of the magrittr %>% operator developed by Stefan Milton Bache.

  • The engine for quasiquotation and expression capture is powered by the rlang package by Lionel Henry and Hadley Wickham.

  • The “triple arrow” notation for the composition operator is taken from the Haskell Control.Arrow library by Ross Paterson.

License

MIT Copyright © 2018 Eugene Ha