{"Encoding":"UTF-8","Package":"plumber","Type":"Package","Title":"An API Generator for R","Version":"1.0.0","Authors@R":"c(\nperson(\"Barret\", \"Schloerke\", role = c(\"cre\", \"aut\"), email = \"barret@rstudio.com\"),\nperson(\"Jeff\", \"Allen\", role = c(\"aut\", \"ccp\"), email = \"cran@trestletech.com\"),\nperson(\"Bruno\", \"Tremblay\", role = \"ctb\", email = \"cran@neoxone.com\"),\nperson(\"Frans\", \"van Dunn\", role = \"ctb\", email = \"frans@ixpantia.com\"),\nperson(\"Sebastiaan\", \"Vandewoude\", role=\"ctb\", email = \"sebastiaanvandewoude@gmail.com\"),\nperson(family = \"RStudio\", role = c(\"cph\", \"fnd\")))","License":"MIT + file LICENSE","BugReports":"https://github.com/rstudio/plumber/issues","URL":"https://www.rplumber.io, https://github.com/rstudio/plumber","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),\nwebutils (>= 1.1), httpuv (>= 1.5.0), crayon, promises (>=\n1.1.0), sodium, swagger (>= 3.33.0), magrittr, mime, lifecycle","LazyData":"TRUE","ByteCompile":"TRUE","Suggests":"testthat (>= 0.11.0), rmarkdown, base64enc, htmlwidgets,\nvisNetwork, later, readr, yaml, feather, future","RoxygenNote":"7.1.1","Collate":"'async.R' 'content-types.R' 'default-handlers.R' 'hookable.R'\n'shared-secret-filter.R' 'parser-cookie.R' 'parse-body.R'\n'parse-query.R' 'plumber.R' 'deprecated-R6.R' 'deprecated.R'\n'digital-ocean.R' 'find-port.R' 'globals.R' 'includes.R'\n'json.R' 'new-rstudio-project.R' 'openapi-spec.R'\n'openapi-types.R' 'paths.R' 'plumb-block.R' 'plumb-globals.R'\n'plumb.R' 'plumber-options.R' 'plumber-response.R'\n'plumber-static.R' 'plumber-step.R' 'pr.R' 'pr_set.R'\n'serializer.R' 'session-cookie.R' 'ui.R' 'utf8.R'\n'utils-pipe.R' 'utils.R' 'validate_api_spec.R' 'zzz.R'","RdMacros":"lifecycle","NeedsCompilation":"no","Packaged":"2020-09-14 16:36:27 UTC; barret","Author":"Barret Schloerke [cre, aut],\nJeff Allen [aut, ccp],\nBruno Tremblay [ctb],\nFrans van Dunn [ctb],\nSebastiaan Vandewoude [ctb],\nRStudio [cph, fnd]","Maintainer":"Barret Schloerke ","Repository":"CRAN","Date/Publication":"2020-09-14 21:40:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/plumber_1.0.0.tar.gz","jsonAuthors":[{"name":"Barret Schloerke","email":"barret@rstudio.com","maintainer":true},{"name":"Jeff Allen","email":"cran@trestletech.com","maintainer":false},{"name":"Bruno Tremblay","email":"cran@neoxone.com","maintainer":false},{"name":"Frans van Dunn","email":"frans@ixpantia.com","maintainer":false},{"name":"Sebastiaan Vandewoude","email":"sebastiaanvandewoude@gmail.com","maintainer":false},{"name":" RStudio","email":null,"maintainer":false}],"readme":"# `plumber`

\n\n\n[![R build status](https://github.com/rstudio/plumber/workflows/R-CMD-check/badge.svg)](https://github.com/rstudio/plumber/actions)\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/rstudio/plumber/branch/master/graph/badge.svg)](https://codecov.io/gh/rstudio/plumber)\n[![RStudio community](https://img.shields.io/badge/community-plumber-blue?style=social&logo=rstudio&logoColor=75AADB)](https://community.rstudio.com/tags/plumber)\n\n\nPlumber allows you to create a web API by merely decorating your existing R\nsource code with special comments. Take a look at an example.\n\n```r\n# plumber.R\n\n#* Echo back the input\n#* @param msg The message to echo\n#* @get /echo\nfunction(msg=\"\") {\n list(msg = paste0(\"The message is: '\", msg, \"'\"))\n}\n\n#* Plot a histogram\n#* @png\n#* @get /plot\nfunction() {\n rand <- rnorm(100)\n hist(rand)\n}\n\n#* Return the sum of two numbers\n#* @param a The first number to add\n#* @param b The second number to add\n#* @post /sum\nfunction(a, b) {\n as.numeric(a) + as.numeric(b)\n}\n```\n\nThese comments allow `plumber` to make your R functions available as API\nendpoints. You can use either `#*` as the prefix or `#'`, but we recommend the\nformer since `#'` will collide with Roxygen.\n\n```r\nlibrary(plumber)\n# 'plumber.R' is the location of the file shown above\npr(\"plumber.R\") %>%\n pr_run(port=8000)\n```\n\nYou can visit this URL using a browser or a terminal to run your R function and\nget the results. For instance\n`http://localhost:8000/plot` will show you a\nhistogram, and\n`http://localhost:8000/echo?msg=hello`\nwill echo back the 'hello' message you provided.\n\nHere we're using `curl` via a Mac/Linux terminal.\n\n```\n$ curl \"http://localhost:8000/echo\"\n {\"msg\":[\"The message is: ''\"]}\n$ curl \"http://localhost:8000/echo?msg=hello\"\n {\"msg\":[\"The message is: 'hello'\"]}\n```\n\nAs you might have guessed, the request's query string parameters are forwarded\nto 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.\n\n```r\nremotes::install_github(\"rstudio/plumber\")\nlibrary(plumber)\n```\n\n## Hosting\n\nIf you're just getting started with hosting cloud servers, the\n[DigitalOcean](https://www.digitalocean.com) integration included in `plumber`\nwill be the best way to get started. You'll be able to get a server hosting your\ncustom API in just two R commands. To deploy to DigitalOcean, check out the\n`plumber` companion package [`plumberDeploy`](https://github.com/meztez/plumberDeploy).\n\n[RStudio Connect](https://rstudio.com/products/connect/) is a commercial\npublishing platform that enables R developers to easily publish a variety of R\ncontent types, including Plumber APIs. Additional documentation is available at\nhttps://www.rplumber.io/articles/hosting.html#rstudio-connect-1.\n\nA couple of other approaches to hosting plumber are also made available:\n\n - PM2 - https://www.rplumber.io/articles/hosting.html#pm2-1\n - Docker - https://www.rplumber.io/articles/hosting.html#docker-basic-\n## Related Projects\n\n- [OpenCPU](https://www.opencpu.org/) - A server designed for hosting R APIs\n with an eye towards scientific research.\n- [jug](http://bart6114.github.io/jug/index.html) - *(development discontinued)*\n an R package similar to Plumber but uses a more programmatic approach to\n constructing the API.","jobInfo":{"package":"plumber","version":"1.0.0","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-03-24T06:29:48+0000"}}

Description

Usage

Arguments

Value