Momocs2: Modern Morphometrics and Shape Manipulation

# Tidy eval -----------------------------------------------

#' Tidy eval helpers
#'
#' @description
#'
#' * [`sym()`][rlang::quotation] creates a symbol from a string and
#'   [`syms()`][rlang::quotation] creates a list of symbols from a
#'   character vector.
#'
#' * [`enquo()`][rlang::quotation] and
#'   [`enquos()`][rlang::quotation] delay the execution of one or
#'   several function arguments. `enquo()` returns a single quoted
#'   expression, which is like a blueprint for the delayed computation.
#'   `enquos()` returns a list of such quoted expressions.
#'
#' * [`expr()`][rlang::quotation] quotes a new expression _locally_. It
#'   is mostly useful to build new expressions around arguments
#'   captured with [enquo()] or [enquos()]:
#'   `expr(mean(!!enquo(arg), na.rm = TRUE))`.
#'
#' * [rlang::as_name()] transforms a quoted variable name
#'   into a string. Supplying something else than a quoted variable
#'   name is an error.
#'
#'   That's unlike [rlang::as_label()] which also returns
#'   a single string but supports any kind of R object as input,
#'   including quoted function calls and vectors. Its purpose is to
#'   summarise that object into a single label. That label is often
#'   suitable as a default name.
#'
#'   If you don't know what a quoted expression contains (for instance
#'   expressions captured with `enquo()` could be a variable
#'   name, a call to a function, or an unquoted constant), then use
#'   `as_label()`. If you know you have quoted a simple variable
#'   name, or would like to enforce this, use `as_name()`.
#'
#' To learn more about tidy eval and how to use these tools, visit
#' <https://tidyeval.tidyverse.org> and the
#' [Metaprogramming
#' section](https://adv-r.hadley.nz/metaprogramming.html) of [Advanced R](https://adv-r.hadley.nz).
#'
#' @md
#' @name tidyeval
#' @keywords internal
#' @importFrom rlang expr enquo enquos sym syms .data := as_name as_label
#' @aliases expr enquo enquos sym syms .data := as_name as_label
#' @export expr enquo enquos sym syms .data := as_name as_label
NULL

# Pipe ----------------------------------------------------
#' Pipe operator
#'
#' See `magrittr::[\%>\%][magrittr::pipe]` for details.
#'
#' @name %>%
#' @rdname pipe
#' @keywords internal
#' @export
#' @importFrom magrittr %>%
#' @export
#' @usage lhs \%>\% rhs
#' @usage lhs \%$\% rhs
#' @usage lhs \%T>\% rhs
#'
#' @examples
#' # Quick introduction to pipe operators
#'
#' x <- 1:5
#'
#' ### %>% the forward operator
#' x %>% mean()
#' # is equivalent to
#' mean(x)
#'
#' ### %T>% the tee operator
#' x %T>% plot %>% mean()
#' # it takes left hand side, do something (here a plot)
#' # then pass it to next function (mean)
#'
#' ### %$% the exposition operator
#' l <- list(x=x, x2=x^2)
#' l %$% x
#' # or
#' l %$% mean(x2)
#' # names in l (x and x2) are "exposed" to right hand side
#'
#' # See magrittr vignette for more!
NULL

#' @importFrom magrittr %$%
#' @export
magrittr::`%$%`

#' @importFrom magrittr %T>%
#' @export
magrittr::`%T>%`