stop_if_reserved: Check for reserved option names.

Description Usage Arguments Value Details See Also

View source: R/options.R

Description

Utility function checking for reserved names.

Usage

1

Arguments

...

Comma-separated [key]=[value] pairs

Value

logical, indicating if any of the keys was reserved (invisibly).

Details

This is a utility function that checks if the keys of the key-value pairs ... contain reserved words. The reserved words are

.__defaults, .__reserved.

If reserved words are encountered in the input an error thrown. The package vignette has examples of its use:

vignette('settings',package='options')

See Also

is_setting


settings documentation built on May 7, 2021, 5:06 p.m.