home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Educational / R-0.49-MI / R-0.49-I / help / survival4 / is.ratetable < prev    next >
Encoding:
Text File  |  1997-09-13  |  1.0 KB  |  30 lines
  1.     
  2.     _V_e_r_i_f_y _t_h_a_t _a_n _o_b_j_e_c_t _i_s _o_f _c_l_a_s_s _r_a_t_e_t_a_b_l_e. _T_h_e _f_u_n_c_t_i_o_n
  3.     _v_e_r_i_f_i_e_s _n_o_t _o_n_l_y _t_h_e _c_l_a_s_s _a_t_t_r_i_b_u_t_e, _b_u_t _t_h_e _s_t_r_u_c_t_u_r_e _o_f
  4.     _t_h_e _o_b_j_e_c_t.
  5.     
  6.          is.ratetable(x, verbose=F)
  7.     
  8.     _A_r_g_u_m_e_n_t_s:
  9.     
  10.                 x:
  11.          the object to be verified.
  12.     
  13.           verbose:
  14.          if TRUE and the object is not a ratetable, then return
  15.          a character string describing the way(s) in which x
  16.          fails to be a proper ratetable object.
  17.     
  18.          Value:
  19.     
  20.          returns TRUE if x is a ratetable, and FALSE or a
  21.          description if it is not.  Rate tables are used by the
  22.          pyears and survexp functions, and normally contain
  23.          death rates for some population, categorized by age,
  24.          sex, or other variables.  They have a fairly rigid
  25.          structure, and the verbose option can help in creating
  26.          a new rate table.
  27.     
  28.          pyears, survexp
  29.     
  30.