isFounder            package:GeneticsPed            R Documentation

_F_o_u_n_d_e_r _a_n_d _n_o_n-_f_o_u_n_d_e_r _i_n_d_i_v_i_d_u_a_l_s _i_n _t_h_e _p_e_d_i_g_r_e_e

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

     'isFounder' classifies individuals in the pedigree as founders
     (base) or non-founders (non-base individuals).

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

       isFounder(x, col=attr(x, ".ascendant"))

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

       x: pedigree object

     col: character, which columns should be checked, see examples

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

     By definition founders do not have any known ascendants, while the
     opossite is the case for non-founders i.e. they have at least one
     known ascendant.

     FIXME: any relation with founderGeneSet in GeneticsBase

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

     Boolean vector.

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

     Gregor Gorjanc

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

     'Pedigree'

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

       ped <- generatePedigree(nId=5)
       isFounder(ped)
       ## Based only on fathers
       isFounder(ped, col=c("father"))
       ## Works also only on a part of a pedigree
       isFounder(ped[1:5, ])

