%<>%

From magrittr v1.5 by Stefan Milton Bache

magrittr compound assignment pipe-operator

Pipe an object forward into a function or call expression and update the lhs object with the resulting value.

Usage

lhs %<>% rhs

Arguments

lhs: An object which serves both as the initial value and as target.
rhs: a function call using the magrittr semantics.

Details

The compound assignment pipe-operator, %<>%, is used to update a value by first piping it into one or more rhs expressions, and then assigning the result. For example, some_object %<>% foo %>% bar is equivalent to some_object <- some_object %>% foo %>% bar. It must be the first pipe-operator in a chain, but otherwise it works like %>%.

Examples

library(magrittr)

iris$Sepal.Length %<>% sqrt

x <- rnorm(100)

x %<>% abs %>% sort

is_weekend <- function(day)
{
   # day could be e.g. character a valid representation
   day %<>% as.Date

   result <- day %>% format("%u") %>% as.numeric %>% is_greater_than(5)

   if (result)
     message(day %>% paste("is a weekend!"))
   else
     message(day %>% paste("is not a weekend!"))

   invisible(result)
}

Documentation reproduced from package magrittr, version 1.5, License: MIT + file LICENSE

Community examples

Looks like there are no examples yet.