censtats                package:NADA                R Documentation

_P_r_o_d_u_c_e_s _s_u_m_m_a_r_y _s_t_a_t_i_s_t_i_c_s _u_s_i_n_g _R_O_S, _M_L_E, _a_n_d _K-_M _m_e_t_h_o_d_s.

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

     A convenience function that produces a comparative table of
     summary statistics obtained using the 'cenros', 'cenmle' and
     'cenfit' routines.  These methods are, Regression on Order
     Statistics (ROS), Maximum Likelihood Estimation (MLE), and
     Kaplan-Meier (K-M).

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

         censtats(obs, censored)

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

     obs: A numeric vector of observations. 

censored: A  logical vector indicating TRUE where an observation in x
          is censored (a less-than value) and FALSE otherwise.   

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

     If the data do not fulfill the criteria for the application of 
     any method no summary statistics will be produced.

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

     A dataframe with the summary statistics.

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

     Lopaka(Rob) Lee <rclee@usgs.gov>

     Dennis Helsel <dhelsel@usgs.gov>

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

     Helsel, Dennis R. (2005).  Nondectects and Data Analysis;
     Statistics for censored environmental data.  John Wiley and Sons,
     USA, NJ.

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

         data(DFe)
         with(DFe, censtats(Summer, SummerCen))

