pedigree                package:lme4                R Documentation

_P_e_d_i_g_r_e_e _C_o_n_s_t_r_u_c_t_o_r

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

     Construct an object of class '"pedigree"', more conveniently than
     by 'new("pedigree", ....)'.

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

     pedigree(sire, dam, label)

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

    sire: numeric vector (with some 'NA' entries) of integer IDs,
          denoting a _previous_ entry in the pedigree corresponding to
          the current entry's "father".

     dam: similarly as 'sire' for the "mother" of each entry.

   label: a vector coercable to '"character"' of the same length as
          'sire' and 'dam' giving a unique ID for the corresponding
          entry.

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

     an object of formal class '"pedigree"'.

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

     the 'pedigree' class.

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

     example("pedigree-class") ## 'p1' pedigree object `the hard way'

     ped <- pedigree(sire = c(NA,NA,1, 1,4,5),
                     dam  = c(NA,NA,2,NA,3,2), label= 1:6)
     ## note that 'label' is coerced to character automatically
     ped
     stopifnot(identical(ped, p1))

