Skip to content

Load roxygen2 options

Source: R/options.R
load_options.Rd

Options can be stored in DESCRIPTION using Config/roxygen2/ fields, or in man/roxygen/meta.R. 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

load_options(base_path = ".")

roxy_meta_get(key = NULL, default = NULL)

Arguments

base_path

Path to package.

key

Key of the options, e.g. "packages".

default

Default value.

Possible options

  • roclets <character>: giving names of roclets to run. See roclet_find() for details.

  • packages <character>: packages to load that implement new tags.

  • load <string>: how to load R code. See load for details.

  • old_usage <flag>: use old style usage formatting?

  • markdown <flag>: translate markdown syntax to Rd?

  • r6 <flag>: document R6 classes?

  • current_package <string> (read only): name of package being documented.

  • rd_family_title <list>: overrides for @family titles. See the rd vignette for details: vignette("rd", package = "roxygen2")

  • knitr_chunk_options <list>: default chunk options used for knitr.

  • restrict_image_formats <flag>: if TRUE then PDF images are only included in the PDF manual, and SVG images are only included in the HTML manual. (This only applies to images supplied via markdown.)

How to set

Either set in DESCRIPTION using Config/roxygen2/ fields:

Config/roxygen2/markdown: TRUE
Config/roxygen2/load: installed

Or if you need more complex options (like rd_family_title or knitr_chunk_options), put them in man/roxygen/meta.R:

list(
  rd_family_title = list(models = "Model functions"),
  knitr_chunk_options = list(fig.width = 7)
)

See also

Other extending: parse_package(), rd_section(), roc_proc_text(), roclet_find(), roxy_block(), roxy_tag(), roxy_tag_rd(), tag_parsers, tags_list()