config {roxytypes}R Documentation

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 $.

Value

(list) A named list of configured behaviors.


[Package roxytypes version 0.1.2 Index]