cointReg (version 0.2.0)

checkVars: Multiple variable checks for certain values.

Description

Checking the arguments and convert them for internal use, if necessary.

Usage

checkVars(..., out = "assign", .env)

Arguments

...

[any] Variables to check, see details.

out

[character] Whether to "return" or to "assign" the checked (and converted) object. Also possible: c("return", "assign").

.env

[environment] Environment to which to assign the converted obj (usually the same on that contains obj, if it's a variable). Required, if argument out contains "assign".

Value

The checked and converted arguments are assigned to the given environment (.env) or invisibly returned as a list.

Details

See checkObject for details.

See Also

Other check: checkDoptions, checkObject

Examples

env = environment()
x.data = data.frame(a = 1:10, b = 20:11)
y.data = 1:10
checkVars(x.coint = x.data, y = y.data, .env = env)
x.coint
y

test = checkVars(x.coint = x.data, y = y.data, out = "return")
str(test)

# If the variables already have the "right" name,
# there's no need to do something like
# checkVars(kernel = kernel, bandwidth = bandwidth) -
# just call checkVars without specifing the arguments:
kernel = "q"
bandwidth = "a"
(checkVars(kernel, bandwidth, out = "return"))