naresid                package:stats                R Documentation

_A_d_j_u_s_t _f_o_r _M_i_s_s_i_n_g _V_a_l_u_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Use missing value information to adjust residuals and predictions.

_U_s_a_g_e:

     naresid(omit, x, ...)
     napredict(omit, x, ...)

_A_r_g_u_m_e_n_t_s:

    omit: an object produced by an 'na.action' function, typically the
          '"na.action"' attribute of the result of 'na.omit' or
          'na.exclude'.

       x: a vector, data frame, or matrix to be adjusted based upon the
          missing value information.

     ...: further arguments passed to or from other methods.

_D_e_t_a_i_l_s:

     These are utility functions used to allow 'predict', 'fitted' and
     'residuals' methods for modelling functions to compensate for the
     removal of 'NA's in the fitting process.  They are used by the
     default, '"lm"', '"glm"' and '"nls"' methods, and by further
     methods in packages 'MASS', 'rpart' and 'survival'.  Also used for
     the scores returned by 'factanal', 'prcomp' and 'princomp'.

     The default methods do nothing.  The default method for the
     'na.exclude' action is to pad the object with 'NA's in the correct
     positions to have the same number of rows as the original data
     frame.

     Currently 'naresid' and 'napredict' are identical, but future
     methods need not be.  'naresid' is used for residuals, and
     'napredict' for fitted values and predictions.

_V_a_l_u_e:

     These return a similar object to 'x'.

_N_o_t_e:

     Packages 'rpart' and 'survival5' used to contain versions of these
     functions that had an 'na.omit' action equivalent to that now used
     for 'na.exclude'.

