svyolr                package:survey                R Documentation

_P_r_o_p_o_r_t_i_o_n_a_l _o_d_d_s _a_n_d _r_e_l_a_t_e_d _m_o_d_e_l_s

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

     Fits cumulative link models: proportional odds, probit,
     complementary log-log, and cauchit.

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

     svyolr(formula, design, ...)
     ## S3 method for class 'survey.design2':
     svyolr(formula, design, start, ..., na.action = na.omit, method = c("logistic", 
         "probit", "cloglog", "cauchit"))
     ## S3 method for class 'svyrep.design':
     svyolr(formula,design,...,return.replicates=FALSE, 
         multicore=getOption("survey.multicore"))

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

 formula: Formula: the response must be a factor with at least three
          levels

  design: survey design object 

     ...: dots

   start: Optional starting values for optimization

na.action: handling of missing values

multicore: Use 'multicore' package to distribute computation of
          replicates across multiple processors?

  method: Link function

return.replicates: return the individual replicate-weight estimates

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

     An object of class 'svyolr'

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

     The code is based closely on polr() from the MASS package of
     Venables and Ripley.

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

     'svyglm'

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

     data(api)
     dclus1<-svydesign(id=~dnum, weights=~pw, data=apiclus1, fpc=~fpc)
     dclus1<-update(dclus1, mealcat=cut(meals,c(0,25,50,75,100)))

     svyolr(mealcat~avg.ed+mobility+stype, design=dclus1)

