is.ratetable            package:survival            R Documentation

_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'

_D_e_s_c_r_i_p_t_i_o_n:

     The function verifies not only the 'class' attribute, but the
     structure of the object.

_U_s_a_g_e:

     is.ratetable(x, verbose=FALSE)

_A_r_g_u_m_e_n_t_s:

       x: the object to be verified. 

 verbose: if 'TRUE' and the object is not a ratetable, then return a
          character string describing the way(s) in which 'x' fails to
          be a proper ratetable object. 

_D_e_t_a_i_l_s:

     Rate tables are used by the 'pyears' and 'survexp' functions, and
     normally contain death rates for some population, categorized by
     age, sex, or other variables.  They have a fairly rigid structure,
     and the 'verbose' option can help in creating a new rate table.

_V_a_l_u_e:

     returns 'TRUE' if 'x' is a ratetable, and 'FALSE' or a description
     if it is not.

_S_e_e _A_l_s_o:

     'pyears', 'survexp'

_E_x_a_m_p_l_e_s:

     ## Not run: 
     library(ratetables)
     is.ratetable(survexp.us)  ##Yes
     data(cancer)
     is.ratetable(cancer)  ##No
     ## End(Not run)

