R/insert_pipe.R

In LudvigOlsen/LRO.utilities: Utility functions and addins

#' @title Insert pipe.
#' @description Addin for RStudio for inserting pipe %>%.
#'
#' See \code{details} for setting up key command.
#' @author Ludvig Renbo Olsen, \email{r-pkgs@ludvigolsen.dk}
#' @export
#' @return Inserts \code{\%>\% }
#' @details How to set up key command in RStudio:
#'
#' After installing package.
#' Go to:
#'
#' \code{Tools} >> \code{Addins} >> \code{Browse Addins} >> \code{Keyboard Shortcuts}.
#'
#' Find \code{"Insert Pipe"} and press its field under \code{Shortcut}.
#'
#' Press desired key command.
#'
#' Press \code{Apply}.
#'
#' Press \code{Execute}.
insertPipe <- function() {

  rstudioapi::insertText("%>% ")

}