nlmeODE               package:nlmeODE               R Documentation

_N_o_n-_l_i_n_e_a_r _m_i_x_e_d-_e_f_f_e_c_t_s _m_o_d_e_l_l_i_n_g _i_n _n_l_m_e _u_s_i_n_g _d_i_f_f_e_r_e_n_t_i_a_l _e_q_u_a_t_i_o_n_s

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

     This package combines the 'odesolve' and 'nlme' packages for
     mixed-effects modelling.

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

     nlmeODE(model,data,LogParms,JAC,SEQ,rtol,atol,tcrit,hmin,hmax)

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

   model: A list including the following elements:

          '_D_i_f_f_E_q' A list of formulas containing the ODE's for the
               system in the same order as the compartment numbers,
               i.e. formula i is the ODE for compartment i.

          '_O_b_s_E_q' A formula specifying which state is observed along
               with possible scaling parameters.

          '_P_a_r_m_s' A vector with the names of the parameters used in
               'DiffEq' followed by the parameters in 'ObsEq' and the
               initial state parameters.

          '_S_t_a_t_e_s' A vector with the names of the states in 'DiffEq'.

          '_I_n_i_t' A logical vector with the same length as 'States'
               specifying whether initial state estimates should be
               obtained for the particular state when TRUE.

    data: 'groupedData' object with a formula specifying which columns
          are the dependent and independent variables, and grouping
          factor. Optional columns in the 'groupedData' object are the
          dose 'Dose', dosing compartment 'Cmt', rate of infusion
          'Rate', covariate measurements, etc.

LogParms: If TRUE, the parameters are reparameterized in terms of the
          logarithm of the parameters. Default is TRUE.

     JAC: If TRUE, the Jacobian of the system of ODE's is computed and
          passed to the ODE solver. In some circumstances,  supplying
          the Jacobian can speed up the computations if the system is
          stiff. Default is TRUE.

     SEQ: A logical value, that when TRUE, adds a gradient attribute to
          the returned value calculated by simultaneous solution of the
          sensitivity equations associated with the system of ODE's.
          Default is FALSE.

    rtol: Relative error tolerance for lsoda. Default is 0.01.

    atol: Absolute error tolerance for lsoda. Default is 0.01.

   tcrit: Time beyond which the integration should not proceed. Default
          is NULL.

    hmin: Minimum value of the integration stepsize. Default is 0.

    hmax: Maximum value of the integration stepsize. Default is Inf.

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

     A function compatible with 'nlme' estimation for systems of
     ordinary differential equations (ODE's).

_N_o_t_e:

     For examples of commonly used PK/PD models see 'PKPDmodels'.

_A_u_t_h_o_r(_s):

     Christoffer W. Tornoe <christoffer.tornoe@ferring.com>

_R_e_f_e_r_e_n_c_e_s:

     Tornoe, C. W. et al. (2004) "Non-linear mixed-effects
     pharmacokinetic/pharmacodynamic modelling in NLME using
     differential equations", Computer Methods and Programs in
     Biomedicine, 76(1), 31-40.

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

     'nlme', 'lsoda'

