Nothing
#' @include internal.R
NULL
#' Pipe operator
#'
#' This package uses the pipe operator (`%>%`) to express nested code
#' as a series of imperative procedures.
#'
#' @param lhs,rhs An object and a function.
#'
#' @seealso [magrittr::%>%()], [tee()].
#'
#' @examples
#' # set seed for reproducibility
#' set.seed(500)
#'
#' # generate 100 random numbers and calculate the mean
#' mean(runif(100))
#'
#' # reset the seed
#' set.seed(500)
#'
#' # repeat the previous procedure but use the pipe operator instead of nesting
#' # function calls inside each other.
#' runif(100) %>% mean()
#'
#' @name %>%
#'
#' @rdname pipe
#'
#' @aliases pipe
#'
#' @importFrom magrittr %>%
#'
#' @export
NULL
#' Tee operator
#'
#' This package uses the "tee" operator (`%T>%`) to modify objects.
#'
#' @param lhs,rhs An object and a function.
#'
#' @seealso [magrittr::%T>%()], [pipe()].
#'
#' @examples
#' # the tee operator returns the left-hand side of the result and can be
#' # useful when dealing with mutable objects. In this example we want
#' # to use the function "f" to modify the object "e" and capture the
#' # result
#'
#' # create an empty environment
#' e <- new.env()
#'
#' # create a function to modify an environment and return NULL
#' f <- function(x) {x$a <- 5; return(NULL)}
#'
#' # if we use the pipe operator we won't capture the result since "f"()
#' # returns a NULL
#' e2 <- e %>% f()
#' print(e2)
#'
#' # but if we use the tee operator then the result contains a copy of "e"
#' e3 <- e %T>% f()
#' print(e3)
#'
#' @name %T>%
#'
#' @rdname tee
#'
#' @aliases tee
#'
#' @importFrom magrittr %T>%
#'
#' @export
NULL
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.