funArg-class {widgetInvoke} | R Documentation |
This class is used by the widgetInvoke
to represent the
necessary information for creation of widgets for a function
argument. Each argument for a function maps to an object of class
funArg
, and stored as a list with the others in the
funArgList
slot of the appropriate wFun
object.
The argType
slot can specify a particular type, or use the
string ANY
to allow this argument to be untyped. When using
the fun2wFun
function, the default for a funArg
object
is that if there is no argDefault
specified by the function,
there will be no argType
. Likewise, if there is an
argDefault
, the argType
will be of the same type.
Objects can be created by calls of the form new("funArg", ...)
.
argName
:"character"
: The name
of the argumentargDefault
:"character"
: The
default value of the argument.argType
:"character"
: The type
of the argument (e.g. numeric, character, logical)argLocation
:"character"
: Which
pane of the widget notebook to display this argument.argWidgetType
:"character"
:
What type of widget to use in displaying this argument.argRequired
:"logical"
: Whether
or not this argument is required to have a value for function
evaluation.signature(object = "funArg")
: Retrieves the
argDefault slot.signature(object = "funArg")
: Retrieves
the argLocation slot.signature(object = "funArg")
: Retrieves the
argName slot.signature(object = "funArg")
: Retrieves
the argRequired slot.signature(object = "funArg")
: Retrieves the
argType slot.signature(object = "funArg")
: Retrieves
the argWidgetType slotJeff Gentry
z <- readWIxml(system.file("wFun-example", "apropos.xml", package="widgetInvoke")) a <- funArgList(z)[[1]] argRequired(a) argName(a) argType(a)