- formLongFixed
a list of formulae for the fixed effects component of
each longitudinal outcome. The left hand-hand side defines the response,
and the right-hand side specifies the fixed effect terms. If a single
formula is given (either as a list of length 1 or a formula), then it is
assumed that a standard univariate joint model is being fitted.
- formLongRandom
a list of one-sided formulae specifying the model for
the random effects effects of each longitudinal outcome. The length of the
list must be equal to formLongFixed
.
- formSurv
a formula specifying the proportional hazards regression
model (not including the latent association structure). See
coxph
for examples.
- data
a list of data.frame
objects for each longitudinal outcome
in which to interpret the variables named in the formLongFixed
and
formLongRandom
. The list
structure enables one to include
multiple longitudinal outcomes with different measurement protocols. If the
multiple longitudinal outcomes are measured at the same time points for
each patient, then a data.frame
object can be given instead of a
list
. It is assumed that each data frame is in long format. tibble
objects are automatically converted to plain data.frame
objects.
- survData
a data.frame
in which to interpret the variables named
in the formSurv
. This is optional, and if not given, the required
data is searched for in data
. Default is survData=NULL
.
- timeVar
a character string indicating the time variable in the linear
mixed effects model. If there are multiple longitudinal outcomes and the
time variable is labelled differently in each model, then a character
string vector can be given instead.
- inits
a list of initial values for some or all of the parameters
estimated in the model. Default is NULL
, with initial values
estimated using separate multivariate linear mixed effects and Cox
proportional hazard regression models.
- verbose
logical: if TRUE
, the parameter estimates and other
convergence statistics are value are printed at each iteration of the MCEM
algorithm. Default is FALSE
.
- pfs
logical: if TRUE
, then assuming the MCEM algorithm has
converged, post-fit statistics including the posterior means and variances
of the random effects, and the approximate standard errors are calculated
and returned as part of the model object. Default is TRUE
. If
FALSE
, then these additional calculations are not performed, which
can reduce the overall computational time. This option is intended to be
used with computationally intensive routines such as simulation and
bootstrap standard error estimation where these calculations are not
required.
- control
a list of control values with components:
nMC
integer: the initial number of Monte Carlo samples to be
used for integration in the burn-in phase of the MCEM. Default is
nMC=
100K.
nMCscale
integer: the scale factor for the increase in Monte
Carlo size when Monte Carlo has not reduced from the previous iteration.
Default is nMCscale=5
.
nMCmax
integer: the maximum number of Monte Carlo samples
that the algorithm is allowed to reach. Default is nMCmax=20000
.
burnin
integer: the number of iterations for 'burn-in' phase
of the optimization algorithm. It is computationally inefficient to use a
large number of Monte Carlo samples early on until one is approximately
near the maximum likelihood estimate. Default is burnin=
100K
for type='antithetic'
or type='montecarlo'
and
burnin=
5 for type='sobol'
or type='halton'
. For
standard methods, such a large burn-in will generally be unnecessary and
can be reduced on an application-specific basis.
mcmaxIter
integer: the maximum number of MCEM algorithm
iterations allowed. Default is mcmaxIter=burnin+200
.
convCrit
character string: the convergence criterion to be
used. See Details.
gammaOpt
character string: by default (gammaOpt='NR'
),
\(\gamma\) is updated using a one-step Newton-Raphson iteration, with the
Hessian matrix calculated exactly. If gammaOpt='GN'
, a Gauss-Newton
algorithm-type iteration is implemented, where the Hessian matrix is
approximated based on calculations similar to those used for calculating
the empirical information matrix? If it is used, then the step-length is
adjusted by a nominal scaling parameter of 0.5 in order to reduce the
chance of over-shooting the maximizer.
tol0
numeric: tolerance value for convergence in the
parameters; see Details. Default is tol0=1e-03
.
tol1
numeric: tolerance value for convergence in the
parameters; see Details. Default is tol1=1e-03
.
tol2
numeric: tolerance value for convergence in the
parameters; see Details. Default is tol2=5e-03
for
type='antithetic'
or type='montecarlo'
and tol2=1e-03
for type='sobol'
or type='halton'
.
tol.em
numeric: tolerance value for convergence in the
multivariate linear mixed model (MV-LMM). When \(K > 1\), the optimal
initial parameters are those from the MV-LMM, which is estimated using a
separate EM algorithm. Since both the E- and M-steps are available in
closed-form, this algorithm convergences relatively rapidly with a high
precision. Default is min(1e-04
, tol2
).
rav
numeric: threshold when using convCrit='sas'
that
applies absolute change (when \(<\)rav
) or relative change (when
\(\ge\)rav
) criterion; see Details. Default is
0.1
, which is an order of magnitude higher than the SAS
implementation.
type
character: type of Monte Carlo integration method to
use. Options are
type='montecarlo'
Vanilla Monte Carlo sampling.
type='antithetic'
Variance reduction method using antithetic
simulation. This is the default option.
type='sobol'
Quasi-Monte Carlo with a low
deterministic Sobol sequence with Owen-type scrambling.
type='halton'
Quasi-Monte Carlo with a low deterministic
Halton sequence.