{"id":13400606,"url":"https://github.com/sol-eng/plumbpkg","last_synced_at":"2026-03-11T12:06:47.082Z","repository":{"id":44097180,"uuid":"207638440","full_name":"sol-eng/plumbpkg","owner":"sol-eng","description":"Example R package that includes Plumber APIs","archived":false,"fork":false,"pushed_at":"2021-11-12T13:13:55.000Z","size":23,"stargazers_count":48,"open_issues_count":3,"forks_count":9,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-07-31T19:25:32.345Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sol-eng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-10T18:50:39.000Z","updated_at":"2024-06-13T09:49:46.000Z","dependencies_parsed_at":"2022-08-12T11:00:28.163Z","dependency_job_id":null,"html_url":"https://github.com/sol-eng/plumbpkg","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sol-eng%2Fplumbpkg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sol-eng%2Fplumbpkg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sol-eng%2Fplumbpkg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sol-eng%2Fplumbpkg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sol-eng","download_url":"https://codeload.github.com/sol-eng/plumbpkg/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243537778,"owners_count":20307098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:00:53.843Z","updated_at":"2026-03-11T12:06:47.011Z","avatar_url":"https://github.com/sol-eng.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"# plumbpkg\n\n\u003c!-- badges: start --\u003e\n[![Travis build status](https://travis-ci.org/sol-eng/plumbpkg.svg?branch=master)](https://travis-ci.org/sol-eng/plumbpkg)\n\u003c!-- badges: end --\u003e\n\nThis is a simple package illustrating how to incorporate\n[Plumber](https://www.rplumber.io) APIs into an R package. There are two main\nmotivations behind this example:\n\n1. Demonstrate how to build Plumber APIs into a package\n2. Demonstrate how to test Plumber APIs using [testthat](https://testthat.r-lib.org)\n\n## Installation\n\n```r\n# install.packages(\"remotes\")\nremotes::install_github(\"sol-eng/plumbpkg\")\n```\n\n## Architecture\nThe design of this package is heavily influenced by [this\ndiscussion](https://community.rstudio.com/t/plumber-api-and-package-structure/18099)\non RStudio Community.\n\n```\n── DESCRIPTION\n├── LICENSE\n├── LICENSE.md\n├── NAMESPACE\n├── R\n│   ├── api1.R\n│   └── api2.R\n├── README.md\n├── inst\n│   └── plumber\n│       ├── api1\n│       │   └── plumber.R\n│       └── api2\n│           ├── entrypoint.R\n│           └── plumber.R\n├── man\n├── plumbpkg.Rproj\n└── tests\n    ├── testthat\n    │   ├── test-api1.R\n    │   ├── test-api2.R\n    │   └── test-plumber.R\n    └── testthat.R\n```\n\nThe `R/` directory contains all of the R functions used in the Plumber APIs.\nThis enables the functions to be tested using files in the `tests/` directory.\nThe Plumber APIs are defined in files in `inst/plumber/` and are also tested \nusing testthat and [httr](https://httr.r-lib.org).\n\n\n## Deploy\nThis repository deploys both APIs to [RStudio\nConnect](https://www.rstudio.com/products/connect/) using\n[Travis](https://travis-ci.org/). The deployment is managed by\n[`scripts/deploy-rsc.sh`](scripts/deploy-rsc.sh) and uses the RStudio Connect\nAPI. Because this repository uses Travis, the APIs will only be deployed\n**after** tests have successfully completed.\n\nThere are certainly other ways this content could be deployed, either using\nother CI/CD solutions or using [RStudio Connect's ability to publish content\nfrom a git\nrepository](https://docs.rstudio.com/connect/1.7.6/user/git-backed.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsol-eng%2Fplumbpkg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsol-eng%2Fplumbpkg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsol-eng%2Fplumbpkg/lists"}