use_pipe

Does setup necessary to use magrittr's pipe operator, <code>%&gt;%</code> in your package.
This function requires the use roxygen.<ul>
<li>Adds magrittr to "Imports" in <code>DESCRIPTION</code>.</li>
<li>Imports the pipe operator specifically, which is necessary for internal
use.</li>
<li>Exports the pipe operator, if <code>export = TRUE</code>, which is necessary to make
<code>%&gt;%</code> available to the users of your package.</li>
</ul>

Automate package and project setup tasks that are otherwise
performed manually. This includes setting up unit testing, test
coverage, continuous integration, Git, 'GitHub', licenses, 'Rcpp',
'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

Malcolm Barrett

Andy Teucher

Posit Software, PBC 

use_pipe function

<dl><dt>export</dt>
<dd>If <code>TRUE</code>, the file <code>R/utils-pipe.R</code> is added, which provides
the roxygen template to import and re-export <code>%&gt;%</code>. If <code>FALSE</code>, the necessary
roxygen directive is added, if possible, or otherwise instructions are given.</dd></dl>

Arguments

Use magrittr's pipe in your package — use_pipe

<dl>

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

</dl>

use_pipe: Use magrittr's pipe in your package

Description

Usage

Arguments

Examples