logc                  package:VGAM                  R Documentation

_C_o_m_p_l_e_m_e_n_t_a_r_y-_l_o_g _L_i_n_k _F_u_n_c_t_i_o_n

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

     Computes the complentary-log transformation, including its inverse
     and the first two derivatives.

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

     logc(theta, earg = list(), inverse = FALSE, deriv = 0,
          short = TRUE, tag = FALSE)

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

   theta: Numeric or character. See below for further details.

    earg: Optional list. Extra argument for passing in additional
          information. Values of 'theta' which are less than or equal
          to 1 can be replaced by the 'bvalue' component of the list
          'earg' before computing the link function value. The
          component name 'bvalue' stands for ``boundary value''. See
          'Links' for general information about 'earg'.

 inverse: Logical. If 'TRUE' the inverse function is computed. 

   deriv: Order of the derivative. Integer with value 0, 1 or 2. 

   short: Used for labelling the 'blurb' slot of a 'vglmff-class'
          object. 

     tag: Used for labelling the linear/additive predictor in the
          'initialize' slot of a 'vglmff-class' object. Contains a
          little more information if 'TRUE'. 

_D_e_t_a_i_l_s:

     The complementary-log link function is suitable for parameters
     that are less than unity. Numerical values of 'theta' close to 1
     or out of range result in 'Inf', '-Inf', 'NA' or 'NaN'. The
     arguments 'short' and 'tag' are used only if 'theta' is character.

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

     For 'deriv = 0', the log of 'theta', i.e., 'log(1-theta)' when
     'inverse = FALSE', and if 'inverse = TRUE' then '1-exp(theta)'.

     For 'deriv = 1', then the function returns _d_ 'theta' / _d_ 'eta'
     as a function of 'theta' if 'inverse = FALSE', else if 'inverse =
     TRUE' then it returns the reciprocal.

     Here, all logarithms are natural logarithms, i.e., to base _e_.

_N_o_t_e:

     Numerical instability may occur when 'theta' is close to 1. One
     way of overcoming this is to use 'earg'.

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

     Thomas W. Yee

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

     McCullagh, P. and Nelder, J. A. (1989) _Generalized Linear
     Models_, 2nd ed. London: Chapman & Hall.

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

     'Links', 'loge', 'cloglog', 'loglog', 'logoff'.

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

     ## Not run: 
     logc(seq(-0.2, 1.1, by=0.1))  # Has NAs
     ## End(Not run)
     logc(seq(-0.2, 1.1, by=0.1), earg=list(bval=1-.Machine$double.eps))  # Has no NAs

