config: 'roxytypes' Config

In roxytypes: Typed Parameter Tags for Integration with 'roxygen2'

roxytypes Config

Description

roxytypes exposes a few configuration options for helping to fine-tune your documentation. These are stored as key-values in a list in either the Config/roxytypes field of your DESCRIPTION file, or in a ./man/roxytypes/meta.R file within your package.

Usage

config(path = getwd(), refresh = FALSE, cache = TRUE)

Details

The available settings are listed below. Some fields are nested, which are shown by concatenating nested keys using $.

• format: An optional glue-style string, which can assume values for name, type and description. See ?roxytypes::tags for details on the source of each of these strings.

• verbose: If TRUE, emit extra diagnostic alerts while processing the package.

Value

(list) A named list of configured behaviors.

roxytypes documentation built on Oct. 16, 2024, 1:06 a.m.