vh.options {VhayuR}R Documentation

Vhayu Options

Description

Options in the VhayuR package.

Usage

vh.defaultOptions(set = c("all", "set", "unset"))
vh.getOption(name)
vh.options(...)

Arguments

set Return all default options, just those which are set to a non-NULL value in the Vhayu options or just those which are currently NULL.
name The name of a Vhayu option.
... See below.

Details

Vhayu options are like R options except they are stored in the VhayuR package and not with regular R options. vh.options is similar to the R options command and vh.getOption is similar to the R getOption command.

Invoking vh.options() with no arguments returns a list with the current values of the options. Note that not all options listed below are set initially. To access the value of a single option, one should use getOption("demo"), e.g., rather than options("demo") which is a list of length one. vh.defaultOptions() returns a named list of the default, rather than current, values of all options (or of just the default options whose current values are set or not set).

Each time the VhayuR package is loaded, a new empty list is defined to hold the options and the default values are loaded into that list.

Value

"vh.options" and "vh.defaultOptions" each returns a named list. "vh.getOption" returns the value of a single Vhayu option.

Options used in VhayuR package

loaded:
TRUE if the VhayuR.dll dynamic load library (dll) is loaded. Automatically set. Not normally changed by user.
port:
This option is the port address that is used to contact the Vhayu server. Usually the default is acceptable so the user normally need not to modify this value.
server:
This option should be set by the user to the IP address of their Vhayu server during each session.
verbose:
This option provides additional messages when running the VhayuR package. When the VhayuR package is loaded verbose is loaded with the value of the R option of the same name.

Other options are discussed in vh.get.data.frame.

See Also

options

Examples

# compactly list Vhayu options
str(vh.options())

# set an option and then restore to original state
vh.getOption("x")
op <- vh.options(x = 4)
vh.getOption("x")
vh.options(op)
vh.getOption("x")

## Not run: 
# reset all options which have defaults to their defaults
vh.options(vh.defaultOptions())
# reset all options which have defaults and are unset
vh.options(vh.defaultOptions("unset"))

vh.options(server = "10.10.1.50")
## End(Not run)


[Package VhayuR version 1.1.2 Index]