Skip to content

reside-ic/porcelain

Repository files navigation

porcelain

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. R build status codecov.io CodeFactor

Porcelain helps convert R packages into easily-tested APIs, using plumber. The ideas come from our experience putting complex R APIs into production where it is important that the API behaves predictably even with unpredictable inputs.

The focus of plumber is quickly putting together applications and works like magic. In porcelain we take a more explicit approach defining standard response types and using schemas to make clear the API contract.

While a work-in-progress, we use this in several applications:

Each of these applications is used by web applications written in Kotlin/TypeScript - see this poster for more on our design approach.

For more information, see the package vignettes:

  • vignette("porcelain") - an introduction and example package
  • vignette("cookbook") - a cookbook of endpoint patterns

License

MIT © Imperial College of Science, Technology and Medicine