An R package that converts your existing R code to a web API using a handful of special one-line comments.


plumber allows you to create a REST API by merely decorating your existing R source code with special comments. Take a look at an example.

# plumber.R

#* Echo back the input
#* @param msg The message to echo
#* @get /echo
  list(msg = paste0("The message is: '", msg, "'"))

#* Plot a histogram
#* @png
#* @get /plot
  rand <- rnorm(100)

#* Return the sum of two numbers
#* @param a The first number to add
#* @param b The second number to add
#* @post /sum
function(a, b){
  as.numeric(a) + as.numeric(b)

These comments allow plumber to make your R functions available as API endpoints. You can either prefix the comments with #* or #' but we recommend the former since #' will conflict with the Roxygen package.

> library(plumber)
> r <- plumb("plumber.R")  # Where 'plumber.R' is the location of the file shown above
> r$run(port=8000)

You can visit this URL using a browser or a terminal to run your R function and get the results. For instance http://localhost:8000/plot will show you a histogram, and http://localhost:8000/echo?msg=hello will echo back the ‘hello’ message you provided.

Here we’re using curl via a Mac/Linux terminal.

$ curl "http://localhost:8000/echo"
 {"msg":["The message is: ''"]}
$ curl "http://localhost:8000/echo?msg=hello"
 {"msg":["The message is: 'hello'"]}

As you might have guessed, the request’s query string parameters are forwarded to the R function as arguments (as character strings).

$ curl --data "a=4&b=3" "http://localhost:8000/sum"

If you’re still interested, check out our more thorough documentation.


You can install the latest stable version from CRAN using the following command:


If 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.