Check if the class of the control list is one of those that can be used by the calling function

Share:

Description

This function can be called to check that the control list passed is appropriate for the function to be controlled. It does so by looking up the class of the control argument (defaulting to the control variable in the calling function) and checking if it matches a list of acceptable classes (defaulting to the name of the calling function with "control." prepended).

Usage

1
2
3
4
5
6
7
check.control.class(OKnames = {
    sc <- sys.calls()
    as.character(sc[[length(sc) - 1]][[1]])
}, myname = {
    sc <- sys.calls()
    as.character(sc[[length(sc) - 1]][[1]])
}, control = get("control", pos = parent.frame()))

Arguments

OKnames

List of control function names which are acceptable.

myname

Name of the calling function (used in the error message).

control

The control list. Defaults to the control variable in the calling function.

See Also

set.control.class, print.control.list