load_options: Load roxygen2 options

Description Usage Arguments Possible options How to set

View source: R/options.R

Description

Options can be stored in the Roxygen field of the DESCRIPTION, or in man/roxygen/meta.R. In either case, the code is parsed and evaluated in a child of the base environment. Call roxy_meta_get() to access current option values from within tag and roclet methods.

Options in man/roxygen/meta.R override those present in DESCRIPTION.

Usage

1
2
3
load_options(base_path = ".")

roxy_meta_get(key = NULL, default = NULL)

Arguments

base_path

Path to package.

Possible options

How to set

Either set in DESCRIPTION:

1
Roxygen: list(markdown = TRUE, load = "installed")

Or if longer, you can put in /man/roxygen/meta.R:

1
2
3
4
list(
  markdown = TRUE,
  load = "installed"
)

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