amlbinomial               package:VGAM               R Documentation

_B_i_n_o_m_i_a_l _L_o_g_i_s_t_i_c _R_e_g_r_e_s_s_i_o_n _b_y _A_s_y_m_m_e_t_r_i_c _M_a_x_i_m_u_m _L_i_k_e_l_i_h_o_o_d _E_s_t_i_m_a_t_i_o_n

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

     Binomial quantile regression estimated by maximizing an asymmetric
     likelihood function.

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

     amlbinomial(w.aml=1, parallel=FALSE, digw=4, link="logit", earg=list())

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

     In this documentation the word _quantile_ can often be
     interchangeably replaced by _expectile_ (things are informal
     here).

   w.aml: Numeric, a vector of positive constants controlling the
          percentiles. The larger the value the larger the fitted
          percentile value (the proportion of points below the
          ``w-regression plane''). The default value of unity results
          in the ordinary maximum likelihood (MLE) solution.

parallel: If 'w.aml' has more than one value then this argument allows
          the quantile curves to differ by the same amount as a
          function of the covariates. Setting this to be 'TRUE' should
          force the quantile curves to not cross (although they may not
          cross anyway). See 'CommonVGAMffArguments' for more
          information.

   digw : Passed into 'Round' as the 'digits' argument for the 'w.aml'
          values; used cosmetically for labelling.

link, earg: See 'binomialff'.

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

     The general methodology behind this 'VGAM' family function is
     given in Efron (1992) and full details can be obtained there. This
     model is essentially a logistic regression model (see
     'binomialff') but the usual deviance is replaced by an asymmetric
     squared error loss function; it is multiplied by w.aml for
     positive residuals. The solution is the set of regression
     coefficients that minimize the sum of these deviance-type values
     over the data set, weighted by the 'weights' argument (so that it
     can contain frequencies). Newton-Raphson estimation is used here.

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

     An object of class '"vglmff"' (see 'vglmff-class'). The object is
     used by modelling functions such as 'vglm' and 'vgam'.

_W_a_r_n_i_n_g:

     If 'w.aml' has more than one value then the value returned by
     'deviance' is the sum of all the (weighted) deviances taken over
     all the 'w.aml' values. See Equation (1.6) of Efron (1992).

_N_o_t_e:

     On fitting, the 'extra' slot has list components '"w.aml"' and
     '"percentile"'. The latter is the percent of observations below
     the ``w-regression plane'', which is the fitted values. Also, the
     individual deviance values corresponding to each element of the
     argument 'w.aml' is stored in the 'extra' slot.

     For 'amlbinomial' objects, methods functions for the generic
     functions 'qtplot' and 'cdf' have not been written yet.

     See 'amlpoisson' about comments on the jargon, e.g., _expectiles_
     etc.

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

     Thomas W. Yee

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

     Efron, B. (1992) Poisson overdispersion estimates based on the
     method of asymmetric maximum likelihood. _Journal of the American
     Statistical Association_, *87*, 98-107.

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

     'amlpoisson', 'amlexponential', 'amlnormal', 'alaplace1'.

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

     # Example: binomial data with lots of trials per observation
     set.seed(1234)
     sizevec = rep(100, length=(n <- 200))
     mydat = data.frame(x = sort(runif(n)))
     mydat = transform(mydat,
                       prob=logit(-0+2.5*x+x^2, inverse=TRUE))
     mydat = transform(mydat, y = rbinom(n, size=sizevec, prob=prob))
     mydat = transform(mydat, y = y / sizevec)  # Convert to proportions
     (fit = vgam(y ~ s(x, df=3), fam=amlbinomial(w=c(0.01,0.2,1,5,60)),
                data=mydat, weight=sizevec, trace=TRUE))
     fit@extra

     ## Not run: 
     par(mfrow=c(1,2))
     # Quantile plot
     with(mydat, plot(x, jitter(y), col="blue", las=1, main=
          paste(paste(round(fit@extra$percentile, dig=1), collapse=", "),
                "percentile-expectile curves")))
     with(mydat, matlines(x, fitted(fit), lwd=2, col="blue", lty=1))

     # Compare the fitted expectiles with the quantiles
     with(mydat, plot(x, jitter(y), col="blue", las=1, main=
          paste(paste(round(fit@extra$percentile, dig=1), collapse=", "),
                "percentile curves are red")))
     with(mydat, matlines(x, fitted(fit), lwd=2, col="blue", lty=1))

     for(ii in fit@extra$percentile)
         with(mydat, matlines(x, qbinom(p=ii/100, size=sizevec, prob=prob)/sizevec,
                       col="red", lwd=2, lty=1))
     ## End(Not run)

