plumber: An API Generator for R
Version 0.3.2

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

Browse man pages Browse package API and functions Browse package files

AuthorTrestle Technology, LLC [aut], Jeff Allen [cre], Frans van Dunné [ctb]
Date of publication2017-05-22 03:41:20
MaintainerJeff Allen <cran@trestletech.com>
LicenseMIT + file LICENSE
Version0.3.2
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("plumber")

Man pages

addSerializer: Add a Serializer
do_configure_https: Add HTTPS to a plumber Droplet
do_deploy_api: Deploy or Update an API
do_forward: Forward Root Requests to an API
do_provision: Provision a DigitalOcean plumber server
do_remove_api: Remove an API from the server
do_remove_forward: Remove the forwarding rule
forward: Forward Request to The Next Handler
include_file: Send File Contents as Response
plumber: Plumber Router
PlumberProcessor: A plumber processor
sessionCookie: Store session data in encrypted cookies.

Functions

PlumberProcessor Man page
addSerializer Man page Source code
checkAnalogSea Source code
checkPKI Source code
contentTypeSerializer Source code
cookieFilter Source code
cookieToStr Source code
createPathRegex Source code
default404Handler Source code
defaultErrorHandler Source code
do_configure_https Man page Source code
do_deploy_api Man page Source code
do_forward Man page Source code
do_provision Man page Source code
do_remove_api Man page Source code
do_remove_forward Man page Source code
enumerateVerbs Source code
extractPathParams Source code
forward Man page Source code
getContentType Source code
getRelevantArgs Source code
htmlSerializer Source code
htmlwidgetSerializer Source code
include_file Man page Source code
include_html Man page Source code
include_md Man page Source code
include_rmd Man page Source code
install_api Source code
install_firewall Source code
install_new_r Source code
install_nginx Source code
install_plumber Source code
isWindows Source code
jsonSerializer Source code
nullSerializer Source code
parseBody Source code
parseCookies Source code
parseQS Source code
plumb Man page Source code
plumber Man page
postBodyFilter Source code
queryStringFilter Source code
requireRmd Source code
resolve Source code
sessionCookie Man page Source code
stopOnLine Source code
typeToConverters Source code
typeToRegex Source code
unboxedJsonSerializer Source code
xmlSerializer Source code

Files

inst
inst/examples
inst/examples/01-append
inst/examples/01-append/plumber.R
inst/examples/02-filters
inst/examples/02-filters/plumber.R
inst/examples/04-mean-sum
inst/examples/04-mean-sum/plumber.R
inst/examples/06-sessions
inst/examples/06-sessions/plumber.R
inst/examples/06-sessions/static
inst/examples/06-sessions/static/iframe-secure.html
inst/examples/06-sessions/static/js-cookie.js
inst/examples/06-sessions/static/iframe.html
inst/examples/08-identity
inst/examples/08-identity/plumber.R
inst/examples/09-content-type
inst/examples/09-content-type/plumber.R
inst/examples/07-mailgun
inst/examples/07-mailgun/plumber.R
inst/examples/10-welcome
inst/examples/10-welcome/plumber.R
inst/examples/03-github
inst/examples/03-github/plumber.R
inst/examples/05-static
inst/examples/05-static/README.md
inst/examples/05-static/files
inst/examples/05-static/files/a.html
inst/examples/05-static/files/b.txt
inst/examples/05-static/plumber.R
inst/server
inst/server/plumber.service
inst/server/nginx-ssl.conf
inst/server/nginx.conf
inst/server/forward.conf
inst/server/plumber-api.conf
inst/talks
inst/talks/2015-earl
inst/talks/2015-earl/sales.R
inst/talks/2015-earl/www
inst/talks/2015-earl/www/index.html
inst/talks/2015-earl/www/images
inst/talks/2015-earl/www/images/rhatsforcats.png
inst/talks/2015-earl/www/images/plumber.png
inst/talks/2015-earl/www/images/earl.jpg
inst/talks/2015-earl/www/images/hatsforcats.png
inst/talks/2015-earl/www/lib
inst/talks/2015-earl/www/lib/css
inst/talks/2015-earl/www/lib/css/zenburn.css
inst/talks/2015-earl/www/lib/font
inst/talks/2015-earl/www/lib/font/league-gothic
inst/talks/2015-earl/www/lib/font/league-gothic/league-gothic.woff
inst/talks/2015-earl/www/lib/font/league-gothic/league-gothic.css
inst/talks/2015-earl/www/lib/font/league-gothic/league-gothic.eot
inst/talks/2015-earl/www/lib/font/league-gothic/league-gothic.ttf
inst/talks/2015-earl/www/lib/font/league-gothic/LICENSE
inst/talks/2015-earl/www/lib/font/source-sans-pro
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-regular.eot
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibold.eot
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro.css
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-italic.woff
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibolditalic.ttf
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-regular.ttf
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibold.woff
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-italic.ttf
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibold.ttf
inst/talks/2015-earl/www/lib/font/source-sans-pro/LICENSE
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-italic.eot
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-regular.woff
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibolditalic.eot
inst/talks/2015-earl/www/lib/font/source-sans-pro/source-sans-pro-semibolditalic.woff
inst/talks/2015-earl/www/lib/js
inst/talks/2015-earl/www/lib/js/classList.js
inst/talks/2015-earl/www/lib/js/head.min.js
inst/talks/2015-earl/www/lib/js/html5shiv.js
inst/talks/2015-earl/www/css
inst/talks/2015-earl/www/css/theme
inst/talks/2015-earl/www/css/theme/league.css
inst/talks/2015-earl/www/css/theme/source
inst/talks/2015-earl/www/css/theme/source/league.scss
inst/talks/2015-earl/www/css/theme/source/serif.scss
inst/talks/2015-earl/www/css/theme/source/white.scss
inst/talks/2015-earl/www/css/theme/source/simple.scss
inst/talks/2015-earl/www/css/theme/source/solarized.scss
inst/talks/2015-earl/www/css/theme/source/black.scss
inst/talks/2015-earl/www/css/theme/source/night.scss
inst/talks/2015-earl/www/css/theme/source/blood.scss
inst/talks/2015-earl/www/css/theme/source/sky.scss
inst/talks/2015-earl/www/css/theme/source/moon.scss
inst/talks/2015-earl/www/css/theme/source/beige.scss
inst/talks/2015-earl/www/css/theme/blood.css
inst/talks/2015-earl/www/css/theme/README.md
inst/talks/2015-earl/www/css/theme/night.css
inst/talks/2015-earl/www/css/theme/beige.css
inst/talks/2015-earl/www/css/theme/serif.css
inst/talks/2015-earl/www/css/theme/solarized.css
inst/talks/2015-earl/www/css/theme/white.css
inst/talks/2015-earl/www/css/theme/black.css
inst/talks/2015-earl/www/css/theme/simple.css
inst/talks/2015-earl/www/css/theme/template
inst/talks/2015-earl/www/css/theme/template/settings.scss
inst/talks/2015-earl/www/css/theme/template/theme.scss
inst/talks/2015-earl/www/css/theme/template/mixins.scss
inst/talks/2015-earl/www/css/theme/moon.css
inst/talks/2015-earl/www/css/theme/sky.css
inst/talks/2015-earl/www/css/print
inst/talks/2015-earl/www/css/print/pdf.css
inst/talks/2015-earl/www/css/print/paper.css
inst/talks/2015-earl/www/css/plumber.css
inst/talks/2015-earl/www/css/reveal.scss
inst/talks/2015-earl/www/css/reveal.css
inst/talks/2015-earl/www/js
inst/talks/2015-earl/www/js/reveal.js
inst/talks/2015-earl/www/plugin
inst/talks/2015-earl/www/plugin/multiplex
inst/talks/2015-earl/www/plugin/multiplex/master.js
inst/talks/2015-earl/www/plugin/multiplex/index.js
inst/talks/2015-earl/www/plugin/multiplex/client.js
inst/talks/2015-earl/www/plugin/markdown
inst/talks/2015-earl/www/plugin/markdown/example.md
inst/talks/2015-earl/www/plugin/markdown/marked.js
inst/talks/2015-earl/www/plugin/markdown/markdown.js
inst/talks/2015-earl/www/plugin/markdown/example.html
inst/talks/2015-earl/www/plugin/math
inst/talks/2015-earl/www/plugin/math/math.js
inst/talks/2015-earl/www/plugin/highlight
inst/talks/2015-earl/www/plugin/highlight/highlight.js
inst/talks/2015-earl/www/plugin/zoom-js
inst/talks/2015-earl/www/plugin/zoom-js/zoom.js
inst/talks/2015-earl/www/plugin/print-pdf
inst/talks/2015-earl/www/plugin/print-pdf/print-pdf.js
inst/talks/2015-earl/www/plugin/search
inst/talks/2015-earl/www/plugin/search/search.js
inst/talks/2015-earl/www/plugin/notes
inst/talks/2015-earl/www/plugin/notes/notes.html
inst/talks/2015-earl/www/plugin/notes/notes.js
inst/talks/2015-earl/www/plugin/notes-server
inst/talks/2015-earl/www/plugin/notes-server/index.js
inst/talks/2015-earl/www/plugin/notes-server/notes.html
inst/talks/2015-earl/www/plugin/notes-server/client.js
inst/talks/2015-earl/www/plugin/remotes
inst/talks/2015-earl/www/plugin/remotes/remotes.js
inst/talks/2015-earl/pres.R
inst/talks/2015-earl/sales.html
inst/talks/2015-earl/plumber-talk.pdf
inst/hosted-new.R
inst/hosted
inst/hosted/analogsea-provision.R
inst/hosted/nginx.conf
inst/hosted/docker-compose.yml
tests
tests/testthat.R
tests/testthat
tests/testthat/test-injection.R
tests/testthat/test-postbody.R
tests/testthat/test-filters.R
tests/testthat/test-plumber.R
tests/testthat/test-sessions.R
tests/testthat/test-routing.R
tests/testthat/test-content-type.R
tests/testthat/test-warnings.R
tests/testthat/test-endpoint.R
tests/testthat/test-enumerate.R
tests/testthat/test-path-subst.R
tests/testthat/test-static.R
tests/testthat/test-querystring.R
tests/testthat/files
tests/testthat/files/endpoints-empty.R
tests/testthat/files/filterpath.R
tests/testthat/files/filter-empty.R
tests/testthat/files/path-params.R
tests/testthat/files/serializer-nonexistent.R
tests/testthat/files/static-nodir.R
tests/testthat/files/filters.R
tests/testthat/files/preempt-redundant.R
tests/testthat/files/preempt.R
tests/testthat/files/endpoints-old.R
tests/testthat/files/readme.R
tests/testthat/files/static.R
tests/testthat/files/terminal-filter.R
tests/testthat/files/endpoints.R
tests/testthat/files/serializer.R
tests/testthat/files/serializer-redundant.R
tests/testthat/files/html.R
tests/testthat/files/image.R
tests/testthat/files/warn.R
tests/testthat/files/preempt-empty.R
tests/testthat/files/router.R
tests/testthat/files/preempt-nonexistent.R
tests/testthat/files/integration.R
tests/testthat/files/verbs.R
tests/testthat/files/serializer-empty.R
tests/testthat/files/filter-inject.R
tests/testthat/files/content-type.R
tests/testthat/files/filterasset.R
tests/testthat/files/in-env.R
tests/testthat/files/filter-redundant.R
tests/testthat/files/static
tests/testthat/files/static/index.html
tests/testthat/files/static/test.txt.zip
tests/testthat/files/static/test.txt
tests/testthat/files/include
tests/testthat/files/include/test.html
tests/testthat/files/include/test.md
tests/testthat/files/include/test.Rmd
tests/testthat/files/include/test.txt
tests/testthat/files/includes.R
tests/testthat/test-serializer-htmlwidgets.R
tests/testthat/test-include.R
tests/testthat/test-cookies.R
tests/testthat/test-serializer-json.R
tests/testthat/test-preempt.R
tests/testthat/test-serializer.R
tests/testthat/test-image.R
tests/testthat/test-response.R
NAMESPACE
NEWS.md
R
R/query-string.R
R/cookie-parser.R
R/serializer-xml.R
R/digital-ocean.R
R/post-body.R
R/processor.R
R/processor-image.R
R/serializer-htmlwidget.R
R/globals.R
R/serializer-content-type.R
R/plumber-step.R
R/default-handlers.R
R/session-cookie.R
R/serializer.R
R/paths.R
R/serializer-html.R
R/content-types.R
R/serializer-json.R
R/plumber.R
R/response.R
R/includes.R
README.md
MD5
DESCRIPTION
man
man/plumber.Rd
man/forward.Rd
man/do_configure_https.Rd
man/do_remove_forward.Rd
man/do_deploy_api.Rd
man/addSerializer.Rd
man/sessionCookie.Rd
man/include_file.Rd
man/do_forward.Rd
man/PlumberProcessor.Rd
man/do_remove_api.Rd
man/do_provision.Rd
LICENSE
plumber documentation built on May 23, 2017, 9:03 a.m.