checkVars: Multiple variable checks for certain values.

Description Usage Arguments Details Value See Also Examples

View source: R/check-arguments.R

Description

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

Usage

1
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".

Details

See checkObject for details.

Value

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

See Also

Other check: checkDoptions, checkObject

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
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"))

cointReg documentation built on May 2, 2019, 3:45 a.m.