use_pipe: Use magrittr's pipe in your package

Description Usage Arguments Examples

View source: R/pipe.R

Description

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

Usage

1
use_pipe(export = TRUE)

Arguments

export

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.

Examples

1
2
3
4
## Not run: 
use_pipe()

## End(Not run)

usethis documentation built on Oct. 17, 2021, 1:06 a.m.