Type: | Package |
Title: | Set Options if Unset |
Version: | 1.0 |
Date: | 2015-05-05 |
Author: | Nicholas Hamilton |
Maintainer: | Nicholas Hamilton <n.hamilton@unsw.edu.au> |
Description: | A single function 'options.ifunset(...)' is contained herewith, which allows the user to set a global option ONLY if it is not already set. By this token, for package maintainers this function can be used in preference to the standard 'options(...)' function, making provision for THEIR end user to place 'options(...)' directives within their '.Rprofile' file, which will not be overridden at the point when a package is loaded. |
License: | GPL-2 |
Collate: | 'onLoad.R' 'options-ifunset.R' |
Packaged: | 2015-05-05 04:22:25 UTC; nick |
NeedsCompilation: | no |
Repository: | CRAN |
Date/Publication: | 2015-05-05 06:43:05 |
OptIfUnset Package
Description
Set an option only if is not currently set
Details
This package contains a single function which only updates the global options if the option is presently unset
Examples
options.ifunset(width=100) #NO CHANGE, ALREADY EXISTS
options.ifunset(myuniqueoption=TRUE) #NEW Option Created
Set Options if Unset
Description
This function will set an option if it isn't already present within the global options
returned by the options()
function
Usage
options.ifunset(..., force = FALSE)
Arguments
... |
any options can be defined, using Options can also be passed by giving a single unnamed argument which is a named list. |
force |
Force the Option to Be Set |
Examples
options.ifunset(width=10) #IGNORED, ALREADY EXISTS
options.ifunset(width=10,force=TRUE) #FORCED UPDATE TO OPTION
options.ifunset(myoption=TRUE) #New Option is Created