plumb_api

available_apis

So that packages can ship multiple plumber routers, users should store their Plumber APIs
in the <code>inst</code> subfolder <code>plumber</code> (<code>./inst/plumber/API_1/plumber.R</code>).

Gives the ability to automatically generate and serve an HTTP API
from R functions using the annotations in the R documentation around your
functions.

Barret Schloerke

plumber

An API Generator for R

Jeff Allen

Bruno Tremblay

Frans van Dunné

Sebastiaan Vandewoude

Posit Software, PBC 

plumb_api function

<dl><dt>package</dt>
<dd>Package to inspect</dd>
<dt>name</dt>
<dd>Name of the package folder to <code>plumb()</code>.</dd>
<dt>edit</dt>
<dd>Whether or not to open the API source code for viewing / editing</dd></dl>

Arguments

<ul>
<li><code>plumb_api()</code>: <code>plumb()</code>s a package's Plumber API. Returns a <code>Plumber</code> router object</li>
<li><code>available_apis()</code>: Displays all available package Plumber APIs. Returns a <code>data.frame</code> of <code>package</code>, <code>name</code>, and <code>source_directory</code> information.</li>
</ul>

Functions

Process a Package's Plumber API — plumb_api

<dl>

<dt>package</dt>
<dd>Package to inspect</dd>


<dt>name</dt>
<dd>Name of the package folder to <code>plumb()</code>.</dd>


<dt>edit</dt>
<dd>Whether or not to open the API source code for viewing / editing</dd>

</dl>

plumb_api: Process a Package's Plumber API

Description

Usage

Value

Arguments

Functions

Details