R/api1.R

In sol-eng/plumbpkg: Include Plumber APIs in a Package

hello <- function() {
  "Hello, world!"
}

echo <- function(msg) {
  list(msg = paste0("The message is: ", msg))
}

n_plot <- function(n) {
  n <- as.numeric(n)
  if (n > 1e6) stop("n must be less than or equal to 1e6", call. = FALSE)
  graphics::hist(stats::rnorm(n))
}

add <- function(x, y) {
  x <- as.numeric(x)
  y <- as.numeric(y)
  if (is.na(x) | is.na(y)) stop("Invalid input", call. = FALSE)
  x + y
}

#' Run API 1
#'
#' @param ... Options passed to \code{plumber::plumb()$run()}
#' @examples
#' \dontrun{
#' run_api1()
#' run_api1(swagger = TRUE, port = 8000)
#' }
#' @return A running Plumber API
#' @export
run_api1 <- function(...) {
  plumber::plumb(dir = system.file("plumber", "api1", package = "plumbpkg"))$run(...)
}