config_helpers: Configuration

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

Configuration

Description

Various functions for loading, caching and performing configured behaviors using a user-supplied configuration file.

Usage

config_find_from(path = ".")

config_from_desc(path = ".")

config_from_file(path = ".")

Arguments

path	(character[1]) A file path to use when searching for a config file. Either the file path to a DESCRIPTION or the root path of a package, depending on the context of the function.

Details

This constant is used as a variable name in the package environment while documentation is being built to avoid constantly parsing configurations during evaluation of each tag.

Functions

• config_find_from(): Load a configuration from a path

• config_from_desc(): Load a configuration from a DESCRIPTION file

• config_from_file(): Load a configuration from a dotfile

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