Skip to content

jcpsantiago/plungr

Repository files navigation

Lifecycle: experimental Travis build status Codecov test coverage CRAN status

plungr

plungr (ˈplʌn(d)ʒər) is an opinionated RStudio project template for building Plumber APIs as packages.

Building your API as a package has some benefits:

  • Use testthat to test your functions and the API itself
  • Document every function and every endpoint
  • Easier integration with CI/CD services like Travis or Jenkins
  • Functions are reusable outside of the API project

Using plungr

Install the development version of plungr with:

# install.packages("remotes")
remotes::install_github("ozean12/plungr")

Acknowledgments

plungr wouldn't exist without the golem package, which does an amazing job at packaging Shiny apps.

The idea for this package came from a post by Julia Silge on RStudio community. There you can find further information about the topic of packaging Plumber APIs.

Contributing

PRs, issues and ideas are welcome!

Please note that the plungr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.