initializeOptionContainer: Initialize Option Container (generic)

In rappster/optionr: Management of customized (and nested) project/package options

Description

Convenience function to initialize the option container that is then stored as an R option according to the name/ID provided by id.

Usage

initializeOptionContainer(id = tryCatch(devtools::as.package(".")$package,
  error = function(cond) {     stop("Invalid default value for `id`") }),
  sub_id = character(), components = c("options", ".meta", ".registry"),
  check = TRUE, hidden = TRUE, overwrite = FALSE, ...)

Arguments

id	Signature argument. Object containing suitable information to control the distinct creation process. In the simplest case, this corresponds to the name/ID of a package/package project. But it can also be an instance of a class for which methods for initializeProjectOptions, initializeMeta and initializeRegistry exist.
sub_id	character. Optional ID for a sub layer. Useful for a hub-like option container structure.
check	logical. TRUE: check if an R option with name/ID according to the information in id already exists (in which case an error is thrown); FALSE: no check for existing R options. Note that overwrite will overrule check.
hidden	logical. TRUE: make sure name/ID information in id is preprended with a dot to hide it; FALSE: use name/ID information in id as is. The former reduces the risk of accidentially overwriting existing R options and thus is used by default.
overwrite	logical. TRUE: overwrite existing container; FALSE: create only if no container exists yet.
...	Further arguments to be passed to subsequent functions/methods.

Author(s)

Janko Thyson [e-mail]

References

http://github.com/Rappster/optionr

See Also

initializeOptionContainer-char-method, ensureOptionContainer, getOptionContainer

Examples

## Not run: 

##------------------------------------------------------------------------------
## Default ID //
##------------------------------------------------------------------------------
  
## Make sure initial options are `NULL` //
options("optionr" = NULL)

id_hidden <- paste0(".", devtools::as.package(".")$package)
initializeOptionContainer()
opts <- getOption(id_hidden)
opts$options  
opts$.meta  
opts$.registry  

## Clean up //
options(id_hidden = NULL)

##------------------------------------------------------------------------------
## Explicit ID //
##------------------------------------------------------------------------------
  
id <- "test"
id_hidden <- paste0(".", id)
options(id = NULL)

initializeOptionContainer(id)
opts <- getOption(id_hidden)
opts$options  
opts$.meta  
opts$.registry

## Clean up //
options(id_hidden = NULL)

##------------------------------------------------------------------------------
## Sub ID //
##------------------------------------------------------------------------------
  
id <- "test"
id_hidden <- paste0(".", id)
sub_id <- "a"
options(id = NULL)

initializeOptionContainer(id = id, sub_id = sub_id)
opts <- getOption(id_hidden)
"a" %in% ls(opts)
opts[[sub_id]]$options  
opts[[sub_id]]$.meta  
opts[[sub_id]]$.registry

## Clean up //
options(id_hidden = NULL)
  
##------------------------------------------------------------------------------
## Partial 
##------------------------------------------------------------------------------

id <- "test"
id_hidden <- paste0(".", id)
options(id_hidden = NULL)
initializeOptionContainer(id, components = "options")
opts <- getOption(id_hidden)
opts$options  
opts$.meta
## --> not created
opts$.registry
## --> not created

initializeOptionContainer(id, components = c("options", ".meta"), 
  overwrite = TRUE)
opts <- getOption(id_hidden)
opts$options  
opts$.meta
opts$.registry
## --> not created

## Condition handling //
initializeOptionContainer(id, components = c("nonexisting", "options"), 
  overwrite = TRUE)
opts <- getOption(id_hidden)
ls(opts, all.names = TRUE)

## Clean up //
options(id_hidden = NULL)
  
##------------------------------------------------------------------------------
## As interface //
##------------------------------------------------------------------------------

## Example of how custom classes can be used for creating custom methods //
id <- structure(list(id = "test"), class = "OptionContext.Test")
id
id_hidden <- paste0(".", id$id)

options(id_hidden = NULL)
initializeOptionContainer(id)
## --> calls `initializeProjectOptions()`, `initializeMeta()` and `initializeRegistry()`
## and for each of which methods for signature ID can be defined

getOption(id_hidden)$options  
getOption(id_hidden)$.meta  
getOption(id_hidden)$.registry  
options(id_hidden = NULL)


## End(Not run)

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