roclet_find: Create a roclet from a string.

Description Usage Arguments Examples

View source: R/roclet.R

Description

This provides a flexible way of specifying a roclet in a string.

Usage

1

Arguments

x

Arbitrary R code evaluated in roxygen2 package.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# rd, namespace, and vignette work for backward compatibility
roclet_find("rd")

# But generally you should specify the name of a function that
# returns a roclet
roclet_find("rd_roclet")

# If it lives in another package, you'll need to use ::
roclet_find("roxygen2::rd_roclet")

# If it takes parameters (which no roclet does currently), you'll need
# to call the function
roclet_find("roxygen2::rd_roclet()")

roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.