initializeProjectOptions: Initialize Options (generic)

Description Usage Arguments Author(s) References See Also Examples

Description

Convenience function to initialize a package options environment below an option container.

Usage

1
initializeProjectOptions(id = "options", where, ...)

Arguments

id

Signature argument. Object containing ID information.

where

Signature argument. Object containing location information.

...

Further arguments to be passed to subsequent functions/methods.

Author(s)

Janko Thyson janko.thyson@gmail.com

References

http://github.com/Rappster/optionr

See Also

initializeProjectOptions-char-env-method, setProjectOptions, getProjectOptions, rmProjectOptions

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 

## Default `id` //  
container <- ensureOptionContainer(overwrite = TRUE)  
initializeProjectOptions(where = container)
exists("options", container)

## Different `id` //
container <- ensureOptionContainer(overwrite = TRUE)  
initializeProjectOptions(id = "OPTIONS", where = container)
exists("OPTIONS", container)


## End(Not run)

rappster/optionr documentation built on May 26, 2019, 11:23 p.m.