generatePedigree         package:GeneticsPed         R Documentation

_G_e_n_e_r_a_t_e _P_e_d_i_g_r_e_e _e_x_a_m_p_l_e

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

     'generatePedigree' creates nonoverlapping pedigree example, which
     can be used for demos and code testing.

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

     generatePedigree(nId, nGeneration=3, nFather=round(nId/3),
       nMother=nId - nFather, start=1, generationOrder="increasing",
       colClass="integer")

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

     nId: integer, number of individuals per generation, at least 2

nGeneration: integer, number of generations

 nFather: integer, number of fathers per generation

 nMother: integer, number of mothers per generation

   start: first generation value

generationOrder: character, generation value is "increasing" or
          "decreasing" through generations

colClass: character, class for columns: "integer" or "factor"

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

     An extended, sorted and possibly coded pedigree object with
     following columns: id, father, mother, generation and sex.

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

     Marcos Rico Gutierrez (author of MATLAB code) and Gregor Gorjanc
     (R implementation)

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

     Rico Gutierrez, M. (1999) Los modelos lineales en la mejora
     genetica animal. Ediciones Peninsular. ISBN 84-605-9910-8.

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

     'Pedigree'

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

       generatePedigree(5)
       generatePedigree(nId=5, nGeneration=4, nFather=1, nMother=2)
       generatePedigree(nId=5, nGeneration=4, nFather=1, nMother=2,
                        start=0, generationOrder="decreasing")
       generatePedigree(nId=100, nGeneration=20, nFather=10, nMother=50)

