roxygen2: roclet – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

roclet

Build a new roclet.

Description

To create a new roclet, you will need to create a constructor function that wraps roclet, and then implement the methods described below.

Usage

roclet(subclass, ...)

roclet_preprocess(x, blocks, base_path)

roclet_process(x, blocks, env, base_path)

roclet_output(x, results, base_path, ...)

roclet_clean(x, base_path)

roclet_tags(x)

Arguments

`x`	A `roclet` object.
`blocks`	A list of roxy_block objects.
`base_path`	Path to root of source package.
`env`	Package environment.
`results`	Value returned from your `roclet_process()` method.

Methods

roclet_preprocess() is called after blocks have been parsed but before code has been evaluated. This should only be needed if your roclet affects how code will evaluated. Should return a roclet.
roclet_process() called after blocks have been evaluated; i.e. the @eval tag has been processed, and the object associated with each block has been determined.
roclet_output() is given the output from roclet_process() and should produce files on disk.
roclet_clean() called when roxygenise(clean = TRUE). Should remove any files created by the roclet.

Deprecated methods

roclet_tags() is no longer used; instead provide a roxy_tag_parse() method for each tag.

roxygen2

In-Line Documentation for R

v7.1.1

GPL (>= 2)

Authors

Hadley Wickham [aut, cre, cph] (<https://orcid.org/0000-0003-4757-117X>), Peter Danenberg [aut, cph], Gábor Csárdi [aut], Manuel Eugster [aut, cph], RStudio [cph]

Initial release