Usage
activateMenus()
activeDataSet(dsname, flushModel=TRUE, flushDialogMemory=TRUE)
ActiveDataSet(name)
activeDataSetP()
activeModel(model)
ActiveModel(name)
activeModelP()
aicP()
beginRmdBlock()
beginRnwBlock()
checkActiveDataSet()
checkActiveModel()
checkBoxes(window=top, frame=stop("frame not supplied"),
boxes=stop("boxes not supplied"),
initialValues=NULL, labels=stop("labels not supplied"),
title=NULL, ttk=FALSE) # macro
checkClass(object, class, message=NULL) # macro
checkFactors(n=1)
checkMethod(generic, object, message=NULL, default=FALSE, strict=FALSE,
reportError=TRUE) # macro
checkNumeric(n=1)
checkReplace(name, type=gettextRcmdr("Variable"))
checkTwoLevelFactors(n=1)
checkVariables(n=1)
closeCommander(ask=TRUE, ask.save=ask)
closeDialog(window, release=TRUE) # macro
CommanderWindow()
dataSetsP(n=1)
defmacro(..., expr)
dialogSuffix(window=top, onOK=onOK, onCancel=onCancel, rows, columns,
focus=top, bindReturn=TRUE,
preventGrabFocus=FALSE, preventDoubleClick=FALSE, preventCrisp,
use.tabs=FALSE, notebook=notebook, tabs=c("dataTab", "optionsTab"),
tab.names=c("Data", "Options"), grid.buttons=FALSE, resizable=FALSE,
force.wait=FALSE) # macro
doItAndPrint(command, log=TRUE, rmd=log)
endRmdBlock()
endRnwBlock()
enterMarkdown(command)
enterKnitr(command)
errorCondition(window=top, recall=NULL, message, model=FALSE) # macro
exists.method(generic, object, default=TRUE, strict=FALSE)
Factors(names)
factorsP(n=1)
formulaFields(model, hasLhs=TRUE, glm=FALSE)
flushDialogMemory(what)
gassign(x, value)
getDialog(dialog, defaults=NULL)
## S3 method for class 'combobox':
getFrame(object)
## S3 method for class 'listbox':
getFrame(object)
## S3 method for class 'combobox':
getSelection(object)
## S3 method for class 'listbox':
getSelection(object)
getRcmdr(x, mode="any", fail=TRUE)
gettextRcmdr(...)
glmP()
GrabFocus(value)
groupsBox(recall=NULL, label=gettextRcmdr("Plot by:"),
initialLabel=gettextRcmdr("Plot by groups"),
errorText=gettextRcmdr("There are no factors in the active data set."),
variables=Factors(),
plotLinesByGroup=FALSE, positionLegend=FALSE,
plotLinesByGroupsText=gettextRcmdr("Plot lines by group"),
initialGroup=NULL, initialLinesByGroup=1, window=top) # macro
groupsLabel(frame=top, groupsBox=groupsBox, columnspan=1,
initialText=NULL) # macro
hclustSolutionsP()
initializeDialog(window=top, title="", offset=10, preventCrisp,
use.tabs=FALSE, notebook=notebook,
tabs=c("dataTab", "optionsTab")) # macro
is.valid.name(x)
is.SciViews()
justDoIt(command)
knitrP()
Library(package, pos=length(search()), rmd=TRUE)
listAllModels(envir=.GlobalEnv, ...)
listAOVModels(envir=.GlobalEnv, ...)
listDataSets(envir=.GlobalEnv, ...)
listFactors(dataSet=ActiveDataSet())
listGeneralizedLinearModels(envir=.GlobalEnv, ...)
listLinearModels(envir=.GlobalEnv, ...)
listMultinomialLogitModels(envir=.GlobalEnv, ...)
listNumeric(dataSet=ActiveDataSet())
listPlugins(loaded=FALSE)
listProportionalOddsModels(envir=.GlobalEnv, ...)
listTwoLevelFactors(dataSet=ActiveDataSet())
listVariables(dataSet=ActiveDataSet())
lmP()
logger(command, rmd=TRUE)
LogWindow()
MacOSXP()
manualTranslationP()
MarkdownP()
Message(message, type=c("note", "error", "warning"))
MessagesWindow()
modelFormula(frame=top, hasLhs=TRUE) # macro
modelsP(n=1)
multinomP()
Numeric(names)
numericP(n=1)
OKCancelHelp(window=top, helpSubject=NULL, model=FALSE,
reset=NULL, apply=NULL) # macro
OutputWindow()
packageAvailable(name)
polrP()
popCommand()
popOutput()
putDialog(dialog, values=NULL, resettable=TRUE)
putRcmdr(x, value)
radioButtons(window=top, name=stop("name not supplied"),
buttons=stop("buttons not supplied"),
values=NULL, initialValue=..values[1],
labels=stop("labels not supplied"),
title="", title.color=getRcmdr("title.color"),
right.buttons=FALSE, command=function(){}) # macro
RcmdrEditor(buffer, title="R Commander Editor",
help=NULL, file.menu=NULL, edit.menu=NULL, context.menu=NULL,
toolbar.buttons=NULL)
RcmdrTclSet(name, value)
RcmdrTkmessageBox(message, icon=c("info", "question", "warning",
"error"), type=c("okcancel", "yesno", "ok"), default, title="")
removeLastRmdBlock()
removeLastRnwBlock()
removeNullRmdBlocks()
removeNullRnwBlocks()
removeStrayRmdBlocks()
removeStrayRnwBlocks()
RExcelSupported()
rglLoaded()
RmdWindow()
RnwWindow()
setBusyCursor()
setIdleCursor()
sortVarNames(x)
subOKCancelHelp(window=subdialog, helpSubject=NULL) # macro
subsetBox(window = top, subset.expression = NULL, model = FALSE) # macro
suppressMarkdown(command)
tclvalue(x)
titleLabel(...)
tkfocus(...)
tkspinbox(parent, ...)
trim.blanks(text)
TwoLevelFactors(names)
twoLevelFactorsP(n=1)
UpdateModelNumber(increment=1)
variableComboBox(parentWindow, variableList=Variables(),
export="FALSE", state="readonly",
initialSelection=gettextRcmdr(""),
title="")
variableListBox(parentWindow, variableList=Variables(), bg="white",
selectmode="single", export="FALSE", initialSelection=NULL,
listHeight=getRcmdr("variable.list.height"), title)
Variables(names)
varPosn(variables,
type=c("all", "factor", "numeric", "nonfactor", "twoLevelFactor"),
vars=NULL)
WindowsP()
X11P()
# the following functions are exported for technical reasons,
# but are not meant to be called directly
commanderPosition()
Arguments
ask.save
ask whether to save contents of script and output windows.
apply
if non-null (the default is NULL
), an Apply button is included in the dialog's button bar.
This argument should be set to the quoted name of the function that initiates the dialog;
when the button is pressed, the onOK
bindReturn
if TRUE
, the Return key is bound to the onOK
function in the dialog.
boxes
vector of quoted names for check boxes, used to generate each box and its associated variable.
buffer
a text string, typically representing the contents of a text widget, such as an R Markdown or
knitr document.
buttons
vector of quoted names for buttons in a set of related radio buttons.
class
quoted name of class.
columnspan
number of dialog-box columns to be spanned by frame.
command
a character string that evaluates to an R command or (in the case of radioButton
) a
function to be called when a button is pressed.
context.menu
NULL
or a list containing one or more two-element lists:
the first element, label
, supplies the text label for a menu item
in the RcmdrEditor
right-click context menu; the second element, command
dataSet, dsname
the quoted name of a data frame in memory.
default
default button: if not specified, "ok" for "okcancel", "yes" for "yesno", and "ok" for "ok";
or look for a default method; for putDialog
, a list of defaults for the dialog box if there are no
stored previous values.
defaults
a list of named default values for options in a dialog if no previous selections are stored.
dialog
the quoted name of a dialog box under which previous selections are stored.
edit.menu
NULL
or a list containing one or more two-element lists:
the first element, label
, supplies the text label for a menu item
in the RcmdrEditor
Edit menu; the second element, command
, is a call-
envir
the environment to be searched; should generally be left at the default.
errorText
error message to print if a suitable factor isn't available.
expr
expression constituting the body of the macro; typically a compound expression.
fail
if TRUE
, the default, getRcmdr
will generate an error if the object sought doesn't exist;
if FALSE
and the object doesn't exist, NULL
is returned.
file.menu
NULL
or a list containing one or more two-element lists:
the first element, label
, supplies the text label for a menu item
in the RcmdrEditor
File menu; the second element, command
, is a call-
flushDialogMemory
remove saved values of dialog options so that getDialog
returns NULL
for all dialogs.
flushModel
set (or reset) the active model to NULL? Should normally be TRUE
when the active
data set is changed; an exception is when variables are simply added to, deleted from, or modified in
the data set set.
focus
Tk window to get the focus.
force.wait
call tkwait.window
so that processing is suspended until the dialog
is closed; overrides the Rcmdr tkwait.dialog
option (see Commander
)
if the latter is set frame
frame or quoted name for frame depending upon the function.
generic
quoted name of generic function.
glm
TRUE
if the model is a glm
object, FALSE
otherwise.
grid.buttons
insert call to tkgrid
for the buttons frame (default FALSE
);
use TRUE
for tabbed dialogs and optionally for other dialogs.
groupsBox
listbox object for selecting groups variable.
initialText
initial text to display in the groups label; if NULL
, ""
will be displayed.
hasLhs
does the model formula have a left-hand side?
help
a two element list: the first element, label
, supplies the text label for a menu item
in the RcmdrEditor
Help menu; the second element, command
, is a call-back function to be evaluated
when the menu item is
helpSubject
the quoted name of a help subject, to be called as help(helpSubject)
when the dialog Help button is pressed.
increment
increment to model number; -1 to set back after error.
initialGroup
quoted name of variable to define groups, set as initial selection in Groups variable list;
NULL
(the default) for no initial selection.
initialLinesByGroup
if 1, the lines-by-groups check box is initially checked; 0 to uncheck.
initialLabel
label for groups button before a selection is made.
initialSelection
index of item initially selected, 0-base indexing.
initialValue
for a set of related radio buttons.
initialValues
for a set of related check boxes.
label
label prefix for groups button after a selection is made.
labels
a vector of character strings to label a set of radio buttons or check boxes.
listHeight
Maximum number of elements displayed simultaneously in list box.
loaded
if TRUE
, plug-in packages that are loaded are included in the vector of names
returned.
log
echo command to the script window, as well as executing it and printing its output.
message
error (or other) message.
mode
mode of object to retrieve.
model
the name of a model, as a character string, or a model object,
or TRUE
or FALSE
, depending upon the function.
n
number of items to check for.
names
optional names to be stored.
notebook
notebook windows for a tabbed dialog (default notebook
).
object
an object (depends on context).
offset
in pixels, from top-left of Commander window.
onOK
function to execute when the OK button is pressed.
onCancel
function to execute when the Cancel button or Esc key is pressed.
package
quoted name of package to load.
plotLinesByGroup
include a check box for plotting lines by group?
plotLinesByGroupsText
the label for the plot-lines-by-group check box.
pos
position on search path at which to load package; default is just before the end of the path.
positionLegend
include a check box for a legend?
preventGrabFocus
prevent the dialog box from grabbing the focus.
preventDoubleClick
prevent double-clicking from pressing the OK button, even when the
double.click option is set; necessary for statistical modelling dialogs, which use double-clicking
to build the model formula.
preventCrisp
this argument is ignored, and is present only for backwards compatibility.
recall
function to call after error --- usually the function that initiates the dialog.
release
release the focus if the grab.focus option has been set.
reportError
if TRUE
, report an error message.
reset
quoted name of dialog function, to be invoked with all defaults by Reset button.
resettable
should dialog state be reset when the data set changes? The default is
code{TRUE}.
resizable
should the dialog be resizable by the user? The default is FALSE
.
right.buttons
radio button placed to right of button-labels; defaults to FALSE
.
rmd
enter the command in the R Markdown tab.
rows, columns
numbers of rows and columns of widgets in the dialog box; this is actually no longer used, but
is still present for backwards compatibility.
selectmode
"single"
or "multiple"
.
state
state of the combobox widget; default "readonly"
means
user can't type in the box; set to "normal"
to permit typing.
strict
if TRUE
, only use first element of class vector.
subset.expression
a quoted expression to subset the data set.
tab.names
text to print as tab labels (default c("Data", "Options")
).
tabs
quoted names of tabs for a tabbed dialog (default c("dataTab", "optionsTab")
).
title
Window or dialog-box-element title.
title.color
color for title above radio buttons; defaults to "blue"
.
toolbar.buttons
NULL
or a list containing one or more three-element lists:
the first element, label
, supplies the text label for a button
in the RcmdrEditor
toolbar; the second element, command
, is a call-bac
ttk
use ttk themed widget for check boxes.
type
quoted type of object to check; used to generate check-replace dialog box;
or type of message to print in Message window. For varPosn
, type of variable list.
use.tabs
(default FALSE
) construct a tabbed dialog.
value
an object to be stored or assigned.
values
vector of quoted values associated with radio buttons or check boxes; for putDialog
,
a list of current selections to be stored in support of dialog memory.
variableList
a vector of variable names.
variables
a vector of one or more variable names.
vars
a vector of one or more variable names; if given type
argument is ignored.
what
optional character vector of one or more dialog names for which the memory is to be flushed; if not
specified, all dialog memory will be flushed.
window, parentWindow
a Tk window.
x
an R object name, as a character string, or a tcl variable or object, or a vector of
variable names to be sorted.
...
For gettextRcmdr
, text string or vector of text strings
to translate;
for titleLabel
, arguments to be passed to labelRcmdr
and from there to ttklabel
;
for defmacro
, arguments