Man pages for AlphaSimR
Breeding Program Simulations

aaAdditive-by-additive epistatic deviations
addErrorAdd residual error to genetic values
addSegSiteAdd segregating site to MapPop
AlphaSimR-packageAlphaSimR: Breeding Program Simulations
asCategoricalConvert a normal (Gaussian) trait to an ordered categorical...
attritionLose individuals at random
bvBreeding value
calcGCACalculate GCA
calcPhenoCalculate phenotypes
cChrCombine MapPop chromosomes
checkSexesFind individuals of desired sex
convertTraitsToNamesConvert traits to a vector of names
ddDominance deviations
dot-newPopCreate new population
doubleGenomeDouble the ploidy of individuals
ebvEstimated breeding value
editGenomeEdit genome
editGenomeTopQtlEdit genome - the top QTL
fastRRBLUPFast RR-BLUP
findLociMapSupersetFind LociMap superset
findQtlIndexFind trait QTL index
genicVarAAdditive genic variance
genicVarAAAdditive-by-additive genic variance
genicVarDDominance genic variance
genicVarGTotal genic variance
genParamSumarize genetic parameters
getCandidatesIdentify candidate individuals
getFamDetermine families
getGenMapGet genetic map
getLociNamesRetrieves marker names from genMap
getNumThreadsNumber of available threads
getPedGet pedigree
getQtlMapGet QTL genetic map
getResponseReturns a vector response from a population
getSnpMapGet SNP genetic map
gvGenetic value
hybridCrossHybrid crossing
HybridPop-classHybrid population
importGenMapImport genetic map
importHaploImport haplotypes
importInbredGenoImport inbred, diploid genotypes
isFemaleTest if individuals of a population are female or male
isPopTest if object is of a Population class
LociMap-classLoci metadata
makeCrossMake designed crosses
makeCross2Make designed crosses
makeDHGenerates DH lines
mapLociFinds positions of loci by marker name
MapPop-classRaw population with genetic map
meanEBVMean estimated breeding values
meanGMean genetic values
meanPMean phenotypic values
mendelianSamplingCalculate Mendelian sampling
mergeGenomeCombine genomes of individuals
mergePopsMerge list of populations
MultiPop-classMulti-Population
mutateAdd Random Mutations
NamedMapPop-classRaw population with genetic map and id
newEmptyPopCreates an empty population
newMapPopNew MapPop
newMultiPopCreate new Multi Population
newPopCreate new population
nIndNumber of individuals
parentAverageCalculate parent average
pedigreeCrossPedigree cross
phenoPhenotype
Pop-classPopulation
popVarPopulation variance
popVarCppPopulation variance
pullIbdHaploPull IBD haplotypes
pullMarkerGenoPull marker genotypes
pullMarkerHaploPull marker haplotypes
pullQtlGenoPull QTL genotypes
pullQtlHaploPull QTL haplotypes
pullSegSiteGenoPull segregating site genotypes
pullSegSiteHaploPull seg site haplotypes
pullSnpGenoPull SNP genotypes
pullSnpHaploPull SNP haplotypes
quickHaploQuick founder haplotype simulation
randCrossMake random crosses
randCross2Make random crosses
RawPop-classRaw Population
reduceGenomeCreate individuals with reduced ploidy
resetPopReset population
rnormWithSeedSample normal deviates using a seed
RRBLUPRR-BLUP Model
RRBLUP2RR-BLUP Model 2
RRBLUP_DRR-BLUP Model with Dominance
RRBLUP_D2RR-BLUP with Dominance Model 2
RRBLUP_GCARR-BLUP GCA Model
RRBLUP_GCA2RR-BLUP GCA Model 2
RRBLUPMemUseRRBLUP Memory Usage
RRBLUP_SCARR-BLUP SCA Model
RRBLUP_SCA2RR-BLUP SCA Model 2
RRsol-classRR-BLUP Solution
runMacsCreate founder haplotypes using MaCS
runMacs2Alternative wrapper for MaCS
sampAddEffSample additive effects
sampDomEffSample dominance effects
sampEpiEffSample epistatic effects
sampleHaploSample haplotypes from a MapPop
selectCrossSelect and randomly cross
selectFamSelect families
selectIndSelect individuals
selectLociFind loci on specific chromosomes
selectOPSelect open pollinating plants
selectWithinFamSelect individuals within families
selfSelf individuals
selIndexSelection index
selIntSelection intensity
setEBVSet estimated breeding values (EBV)
setMarkerHaploSet marker haplotypes
setPhenoSet phenotypes
setPhenoGCASet GCA as phenotype
setPhenoProgTestSet progeny test as phenotype
SimParamSimulation parameters
smithHazelCalculate Smith-Hazel weights
solveMKMSolve Multikernel Model
solveMVMSolve Multivariate Model
solveRRBLUPSolve RR-BLUP
solveRRBLUP_EMSolve RR-BLUP with EM
solveRRBLUP_EM2Solve RR-BLUP with EM and 2 random effects
solveRRBLUP_EM3Solve RR-BLUP with EM and 3 random effects
solveRRBLUPMKSolve Multikernel RR-BLUP
solveRRBLUPMVSolve Multivariate RR-BLUP
solveUVMSolve Univariate Model
TraitA2-classSex specific additive trait
TraitA2D-classSex specific additive and dominance trait
TraitA-classAdditive trait
TraitAD-classAdditive and dominance trait
TraitADE-classAdditive, dominance, and epistatic trait
TraitADEG-classAdditive, dominance, epistasis, and GxE trait
TraitADG-classAdditive, dominance and GxE trait
TraitAE-classAdditive and epistatic trait
TraitAEG-classAdditive, epistasis and GxE trait
TraitAG-classAdditive and GxE trait
transMatLinear transformation matrix
usefulnessUsefulness criterion
varAAdditive variance
varAAAdditive-by-additive epistatic variance
varDDominance variance
varEBVVariance of estimated breeding values
varGTotal genetic variance
varPPhenotypic variance
writePlinkWrites a Pop-class as PLINK files
writeRecordsWrite data records
AlphaSimR documentation built on Nov. 8, 2025, 5:10 p.m.