options: Roxyglobals options

In roxyglobals: 'Roxygen2' Global Variable Declarations

Roxyglobals options

Description

Get and set roxyglobals options in DESCRIPTION file.

Usage

options_get_unique(file = ".")

options_set_unique(value, file = ".")

options_get_filename(file = ".")

options_set_filename(value, file = ".")

Arguments

file	DESCRIPTION file to use. By default the DESCRIPTION file of the current package (i.e. the package the working directory is part of) is used.
value	The new option value

Value

The option value or nothing

Functions

• options_get_unique(): get unique

• options_set_unique(): set unique

• options_get_filename(): get filename

• options_set_filename(): set filename

Examples

options_get_unique()
## Not run: 
options_set_unique(TRUE)

## End(Not run)
options_get_filename()
## Not run: 
options_set_filename("roxyglobals-generated.R")

## End(Not run)

roxyglobals documentation built on Aug. 21, 2023, 5:14 p.m.