{"Encoding":"UTF-8","Package":"plumber","Type":"Package","Title":"An API Generator for R","Version":"0.3.2","Date":"2017-05-21","Authors@R":"c(\nperson(family=\"Trestle Technology, LLC\", role=\"aut\", email=\"cran@trestletech.com\"),\nperson(\"Jeff\", \"Allen\", role=\"cre\", email=\"cran@trestletech.com\"),\nperson(\"Frans\", \"van Dunn\", role=\"ctb\", email=\"frans@ixpantia.com\"))","License":"MIT + file LICENSE","Description":"Gives the ability to automatically generate and serve an HTTP API\nfrom R functions using the annotations in the R documentation around your\nfunctions.","Depends":"R (>= 3.0.0)","Imports":"R6 (>= 2.0.0), stringi (>= 0.3.0), jsonlite (>= 0.9.16),\nhttpuv (>= 1.2.3)","LazyData":"TRUE","Suggests":"testthat (>= 0.11.0), XML, rmarkdown, PKI, base64enc,\nhtmlwidgets, visNetwork, analogsea","Collate":"'content-types.R' 'cookie-parser.R' 'globals.R'\n'serializer-json.R' 'plumber.R' 'default-handlers.R'\n'digital-ocean.R' 'includes.R' 'paths.R' 'plumber-step.R'\n'post-body.R' 'processor.R' 'processor-image.R'\n'query-string.R' 'response.R' 'serializer-content-type.R'\n'serializer-html.R' 'serializer-htmlwidget.R'\n'serializer-xml.R' 'serializer.R' 'session-cookie.R'","RoxygenNote":"6.0.1","NeedsCompilation":"no","Packaged":"2017-05-22 01:38:33 UTC; jeff","Author":"Trestle Technology, LLC [aut],\nJeff Allen [cre],\nFrans van Dunn [ctb]","Maintainer":"Jeff Allen ","Repository":"CRAN","Date/Publication":"2017-05-22 03:41:20","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/plumber_0.3.2.tar.gz","jsonAuthors":[{"name":" Trestle Technology, LLC","email":"cran@trestletech.com","maintainer":false},{"name":"Jeff Allen","email":"cran@trestletech.com","maintainer":true},{"name":"Frans van Dunn","email":"frans@ixpantia.com","maintainer":false}],"readme":"# plumber\n\n[![Build Status](https://travis-ci.org/trestletech/plumber.svg?branch=master)](https://travis-ci.org/trestletech/plumber)\n[![](https://www.r-pkg.org/badges/version/plumber)](https://www.r-pkg.org/pkg/plumber)\n[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/plumber?color=brightgreen)](https://www.r-pkg.org/pkg/plumber)\n[![codecov](https://codecov.io/gh/trestletech/plumber/branch/master/graph/badge.svg)](https://codecov.io/gh/trestletech/plumber)\n\n

\n\nplumber allows you to create a REST API by merely decorating your existing R source code with special comments. Take a look at an example.\n\n```r\n# myfile.R\n\n#* @get /mean\nnormalMean <- function(samples=10){\n data <- rnorm(samples)\n mean(data)\n}\n\n#* @post /sum\naddTwo <- function(a, b){\n as.numeric(a) + as.numeric(b)\n}\n```\n\nThese comments allow plumber to make your R functions available as API endpoints. You can use either `#*` as the prefix or `#'`, but we recommend the former since `#'` will collide with Roxygen. \n\n```r\n> library(plumber)\n> r <- plumb(\"myfile.R\") # Where 'myfile.R' is the location of the file shown above\n> r$run(port=8000)\n```\n\nYou can visit this URL using a browser or a terminal to run your R function and get the results. Here we're using `curl` via a Mac/Linux terminal.\n\n```\n$ curl \"http://localhost:8000/mean\"\n [-0.254]\n$ curl \"http://localhost:8000/mean?samples=10000\"\n [-0.0038]\n``` \n\nAs you might have guessed, the request's query string parameters are forwarded to the R function as arguments (as character strings).\n\n```\n$ curl --data \"a=4&b=3\" \"http://localhost:8000/sum\"\n [7]\n```\n\nYou can also send your data as JSON:\n\n```\n$ curl --data '{\"a\":4, \"b\":5}' http://localhost:8000/sum\n [9]\n```\n\n## Installation\n\nYou can install the latest stable version from CRAN using the following command:\n\n```r\ninstall.packages(\"plumber\")\n```\n\nIf you want to try out the latest development version, you can install it from GitHub. The easiest way to do that is by using `devtools`.\n\n```r\nlibrary(devtools)\ninstall_github(\"trestletech/plumber\")\nlibrary(plumber)\n```\n\n## Hosting\n\nIf you're just getting started with hosting cloud servers, the DigitalOcean integration included in plumber will be the best way to get started. You'll be able to get a server hosting your custom API in just two R commands. Full documentation is available at http://plumber.trestletech.com/docs/digitalocean/.\n\nA couple of other approaches to hosting plumber are also made available:\n - PM2 - http://plumber.trestletech.com/docs/hosting/\n - Docker - http://plumber.trestletech.com/docs/docker/\n\n## Provenance\n\nplumber was originally released as the `rapier` package and has since been renamed (7/13/2015).\n"}

Description

Usage

Arguments

Format