selectFam {AlphaSimR} | R Documentation |
Selects a subset of full-sib families from a population.
selectFam(pop, nFam, trait = 1, use = "pheno", gender = "B", famType = "B", selectTop = TRUE, returnPop = TRUE, candidates = NULL, simParam = NULL, ...)
pop |
and object of |
nFam |
the number of families to select |
trait |
the trait for selection. Either a number indicating a single trait or a function returning a vector of length nInd. |
use |
select on genetic values "gv", estimated breeding values "ebv", breeding values "bv", phenotypes "pheno", or randomly "rand" |
gender |
which gender to select. Use "B" for both, "F" for females and "M" for males. If the simulation is not using gender, the argument is ignored. |
famType |
which type of family to select. Use "B" for full-sib families, "F" for half-sib families on female side and "M" for half-sib families on the male side. |
selectTop |
selects highest values if true. Selects lowest values if false. |
returnPop |
should results be returned as a
|
candidates |
an optional vector of eligible selection candidates. |
simParam |
an object of |
... |
additional arguments if using a function for trait |
Returns an object of Pop-class
or
HybridPop-class
#Create founder haplotypes founderPop = quickHaplo(nInd=10, nChr=1, segSites=10) #Set simulation parameters SP = SimParam$new(founderPop) SP$addTraitA(10) SP$setVarE(h2=0.5) #Create population pop = newPop(founderPop, simParam=SP) #Create 3 biparental families with 10 progeny pop2 = randCross(pop, nCrosses=3, nProgeny=10, simParam=SP) #Select best 2 families pop3 = selectFam(pop2, 2, simParam=SP)