gif                   package:gap                   R Documentation

_K_i_n_s_h_i_p _c_o_e_f_f_i_c_i_e_n_t _a_n_d _g_e_n_e_t_i_c _i_n_d_e_x _o_f _f_a_m_i_l_i_a_l_i_t_y

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

     The genetic index of familality is defined as the mean kinship
     between all pairs of individuals in a set multiplied by 100,000.
     Formally, it  is defined as 

       100,000 x 2/[n(n-1)]sum_(i=1)^(n-1)sum_(j=i+1)^n k_(ij)

     where n is the number of individuals in the set and k_{ij} is the
     kinship coefficient between individuals i and j.

     The scaling is purely for convenience of presentation.

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

     gif(data,gifset)

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

    data: the trio data of a pedigree

  gifset: a subgroup of pedigree members

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

     The returned value is a list containing:

  gifval: the genetic index of familiarity

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

     Gholamic K, Thomas A (1994) A linear time algorithm for
     calculation of multiple pairwise kinship coefficients and genetic
     index of familiality. Comp Biomed Res 27:342-350

_N_o_t_e:

     Adapted from gif.c, testable with -Dexecutable as standalone
     program,  which can be use for any pair of indidivuals

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

     Alun Thomas, Jing Hua Zhao

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

     'pfc'

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

     ## Not run: 
     test<-c(
      5,      0,      0,
      1,      0,      0,
      9,      5,      1,
      6,      0,      0,
     10,      9,      6,
     15,      9,      6,
     21,     10,     15,
      3,      0,      0,
     18,      3,     15,
     23,     21,     18,
      2,      0,      0,
      4,      0,      0,
      7,      0,      0,
      8,      4,      7,
     11,      5,      8,
     12,      9,      6,
     13,      9,      6,
     14,      5,      8,
     16,     14,      6,
     17,     10,      2,
     19,      9,     11,
     20,     10,     13,
     22,     21,     20)
     test<-matrix(test,ncol=3,byrow=TRUE)
     gif(test,gifset=c(20,21,22))

     # all individuals
     gif(test,gifset=1:23)
     ## End(Not run)

