do_deploy_api

The droplet on which to act. It's expected that this droplet
was provisioned using <code><a rd-options="=do_provision" href="/link/do_provision()?package=plumber&version=0.3.2&to=%3Ddo_provision" data-mini-rdoc="=do_provision::do_provision()">do_provision()</a></code>. See <code><a rd-options="analogsea:droplet" href="/link/analogsea%3A%3Adroplet()?package=plumber&version=0.3.2&to=analogsea%3Adroplet" data-mini-rdoc="analogsea:droplet::analogsea::droplet()">analogsea::droplet()</a></code> to
obtain a reference to a running droplet.

droplet

The remote path/name of the application

path

The local path to the API that you want to deploy. The
entire directory referenced will be deployed, and the <code>plumber.R</code> file
inside of that directory will be used as the root plumber file. The
directory MUST contain a <code>plumber.R</code> file.

localPath

The internal port on which this service should run. This will not
be user visible, but must be unique and point to a port that is available
on your server. If unsure, try a number around <code>8000</code>.

port

If <code>TRUE</code>, will setup requests targeting the root URL on the
server to point to this application. See the <code><a rd-options="=do_forward" href="/link/do_forward()?package=plumber&version=0.3.2&to=%3Ddo_forward" data-mini-rdoc="=do_forward::do_forward()">do_forward()</a></code> function for
more details.

forward

R commands to run after <code><a rd-options="=plumb" href="/link/plumb()?package=plumber&version=0.3.2&to=%3Dplumb" data-mini-rdoc="=plumb::plumb()">plumb()</a></code>ing the <code>plumber.R</code> file,
but before <code>run()</code>ing the plumber service. This is an opportunity to e.g.
add new filters. If you need to specify multiple commands, they should be
semi-colon-delimited.

preflight

Deploys an API from your local machine to make it available on the remote
plumber server.

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

Jeff Allen

plumber

An API Generator for R

 Trestle Technology, LLC

Frans van Dunn<c3><a9>

do_deploy_api function

The droplet on which to act. It's expected that this droplet
was provisioned using <code><a rd-options='=do_provision' href='do_provision()'>do_provision()</a></code>. See <code><a rd-options='analogsea:droplet' href='analogsea::droplet()'>analogsea::droplet()</a></code> to
obtain a reference to a running droplet.

If <code>TRUE</code>, will setup requests targeting the root URL on the
server to point to this application. See the <code><a rd-options='=do_forward' href='do_forward()'>do_forward()</a></code> function for
more details.

R commands to run after <code><a rd-options='=plumb' href='plumb()'>plumb()</a></code>ing the <code>plumber.R</code> file,
but before <code>run()</code>ing the plumber service. This is an opportunity to e.g.
add new filters. If you need to specify multiple commands, they should be
semi-colon-delimited.

do_deploy_api: Deploy or Update an API

Description

Usage

Arguments