lmeControl               package:lme4               R Documentation

_C_o_n_t_r_o_l _v_a_l_u_e_s _f_o_r _l_m_e

_D_e_s_c_r_i_p_t_i_o_n:

     The values supplied in the function call replace the defaults and
     a list with all possible arguments is returned. The returned list
     is used as the 'control' argument in the 'lme' function.

_U_s_a_g_e:

     lmeControl(maxIter, msMaxIter, tolerance, niterEM, msTol,
                msScale, msVerbose, PQLmaxIt, .relStep,
                nlmStepMax, optimizer,
                EMverbose, analyticGradient, analyticHessian)

_A_r_g_u_m_e_n_t_s:

 maxIter: maximum number of iterations for the 'lme' optimization
          algorithm. Default is 50.

msMaxIter: maximum number of iterations for the 'nlm' optimization step
          inside the 'lme' optimization. Default is 50.

tolerance: tolerance for the convergence criterion in the 'lme'
          algorithm. Default is 1e-6.

 niterEM: number of iterations for the EM algorithm used to refine the
          initial estimates of the random effects variance-covariance
          coefficients. Default is 25.

   msTol: tolerance for the convergence criterion in 'nlm', passed as
          the 'rel.tolerance' argument to the function (see
          documentation on 'nlm'). Default is 1e-7. 

 msScale: scale function passed as the 'scale' argument to the 'nlm'
          function (see documentation on that function). Default is
          'lmeScale'.

msVerbose: a logical value passed as the 'trace' argument to 'nlm' (see
          documentation on that function). Default is
          'getOption("verbose")'.

PQLmaxIt: maximum number of iterations for the PQL algorithm in 'GLMM'.

.relStep: relative step for numerical derivatives calculations. Default
          is '.Machine$double.eps^(1/3)'.

nlmStepMax: stepmax value to be passed to nlm. See 'nlm' for details.
          Default is 100.0

optimizer: the optimizer to be used - either '"optim"', the default, or
          '"nlm"'

EMverbose: a logical value indicating if verbose output should be
          produced during the EM iterations.  Default is
          'getOption("verbose"'.

analyticGradient: a logical value indicating if the analytic gradient
          of the objective should be used.  This option is for testing
          purposes and would not normally be changed from the default. 
          Default is 'TRUE'.

analyticHessian: a logical value indicating if the analytic hessian of
          the objective should be calculated. This is an experimental
          feature and at present the default is 'FALSE'. In future we
          may use the analytic Hessian in the optimization.

_V_a_l_u_e:

     a list with a component for each of the possible arguments.

_S_e_e _A_l_s_o:

     'lme', 'nlm', 'optim', 'lmeScale', 'GLMM'

_E_x_a_m_p_l_e_s:

     # decrease the maximum number iterations in the ms call and
     # request that information on the evolution of the ms iterations be printed
     str(lmeControl(msMaxIter = 20, msVerbose = TRUE))

