- formula
a symbolic description of the model to fit, e.g.,
y ~ vc(z1, z2, z3) + vc(z1, z2, by = x1) + vc(z2, z3, by = x2)
where the vc
terms specify the varying fixed
coefficients. The unnamed arguments within vc
terms are
interpreted as partitioning variables (i.e., moderators). The
by
argument specifies the associated predictor variable. If
no such predictor variable is specified (e.g., see the first term in
the above example formula), the vc
term is interpreted as a
varying intercept, i.e., an nonparametric estimate of the direct
effect of the partitioning variables. For details, see
vcrpart-formula
. Note that the global intercept may
be removed by a -1
term, according to the desired
interpretation of the model.
- family
the model family. An object of class
family
.
- data
a data frame containing the variables in the model.
- weights
an optional numeric vector of weights to be used in the
fitting process.
- subset
an optional logical or integer vector specifying a
subset of 'data'
to be used in the fitting process.
- offset
this can be used to specify an a priori known component
to be included in the linear predictor during fitting.
- na.action
a function that indicates what should happen if data
contain NA
s. The default na.action = na.omit
is
listwise deletion, i.e., observations with missings on any variable
are dropped. See na.action
.
- control
a list with control parameters as returned by
tvcglm_control
, or by tvcm_control
for advanced users.
- minsize
numeric (vector). The minimum sum of weights in
terminal nodes.
- mindev
numeric scalar. The minimum permitted training error
reduction a split must exhibit to be considered of a new split.
The main role of this parameter is to save computing time by early
stopping. May be set lower for very few partitioning variables
resp. higher for many partitioning variables.
- maxnomsplit, maxordsplit, maxnumsplit
integer scalars for split
candidate reduction. See tvcm_control
- cv
logical scalar. Whether or not the cp
parameter
should be cross-validated. If TRUE
cvloss
is
called.
- folds
a list of parameters to create folds as produced by
folds_control
. Is used for cross-validation.
- prune
logical scalar. Whether or not the initial tree should be
pruned by the estimated cp
parameter from
cross-validation. Cannot be TRUE
if cv = FALSE
.
- fast
logical scalar. Whether the approximative model should be
used to search for the next split. The approximative search model
uses only the observations of the node to split and incorporates the
fitted values of the current model as offsets. Therewith the
estimation is reduces to the coefficients of the added split. If
FALSE
, the accurate search model is used.
- center
logical integer. Whether the predictor variables of
update models during the grid search should be centered. Note that
TRUE
will not modify the predictors of the fitted model.
- maxstep
integer. The maximum number of iterations i.e. number
of splits to be processed.
- verbose
logical. Should information about the fitting process
be printed to the screen?
- ...
additional arguments passed to the fitting function
fit
or to tvcm_control
.