use_pipe: Use magrittr's pipe in your package

View source: R/pipe.R

use_pipeR Documentation

Use magrittr's pipe in your package


Does setup necessary to use magrittr's pipe operator, ⁠%>%⁠ in your package. This function requires the use roxygen.

  • Adds magrittr to "Imports" in DESCRIPTION.

  • Imports the pipe operator specifically, which is necessary for internal use.

  • Exports the pipe operator, if export = TRUE, which is necessary to make ⁠%>%⁠ available to the users of your package.


use_pipe(export = TRUE)



If TRUE, the file R/utils-pipe.R is added, which provides the roxygen template to import and re-export ⁠%>%⁠. If FALSE, the necessary roxygen directive is added, if possible, or otherwise instructions are given.


## Not run: 

## End(Not run)

usethis documentation built on July 9, 2023, 7:23 p.m.