platen

1 platen

The platen package provides Quarto and roxygen2 extensions to assist in building and documenting R packages and other R projects.

1.1 Installation

You can install the development version of platen from GitHub with:

# install.packages("devtools")
devtools::install_github("PatrickCoyle/platen")

1.2 Example

An example was created by applying platen functions to the platen package itself. This example is saved in the docs/ folder of the Github repository, and is hosted here.

1.3 Why platen?

The FAQ on quarto.org states:

We wanted to use a name that had meaning in the history of publishing and landed on Quarto, which is the format of a book or pamphlet produced from full sheets printed with eight pages of text, four to a side, then folded twice to produce four leaves. The earliest known European printed book is a Quarto, the Sibyllenbuch, believed to have been printed by Johannes Gutenberg in 1452–53.

A platen is a flat platform used in printing presses. Gutenberg’s press used a platen, and later jobbing presses used platens to automate printing in different formats. By connecting roxygen2 with Quarto, platen offers more documentation options to R developers.

1.4 References