porcelain_roclet: Define API using roxygen tags
In reside-ic/porcelain: Turn a Package into an HTTP API
porcelain_roclet R Documentation
Define API using roxygen tags
Description
A roclet for processing @porcelain tags within a package. This
presents an automated declarative approach to defining porcelain
APIs using roxygen tags. When you roxygenise your package (e.g.,
with devtools::document() or roxygen2::roxygenise()) this
roclet will create a file R/porcelain.R within your package that
will be included into your package API.
Usage
porcelain_roclet()
Value
A roclet, used by roxygen2 (not typically called by
users directly)
reside-ic/porcelain documentation built on March 4, 2024, 11:11 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| porcelain_roclet | R Documentation |
Define API using roxygen tags
Description
A roclet for processing @porcelain tags within a package. This
presents an automated declarative approach to defining porcelain
APIs using roxygen tags. When you roxygenise your package (e.g.,
with devtools::document() or roxygen2::roxygenise()) this
roclet will create a file R/porcelain.R within your package that
will be included into your package API.
Usage
porcelain_roclet()
Value
A roclet, used by roxygen2 (not typically called by
users directly)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.