Learn R Programming

⚠️There's a newer version (1.6.0) of this package.Take me there.

README

The successor to the 'AlphaSim' software for breeding program simulation (Faux et al., 2016; https://doi.org/10.3835/plantgenome2016.02.0013). Used for stochastic simulations of breeding programs to the level of DNA sequence for every individual. Contained is a wide range of functions for modeling common tasks in a breeding program, such as selection and crossing. These functions allow for constructing simulations of highly complex plant and animal breeding programs via scripting in the R software environment. Such simulations can be used to evaluate overall breeding program performance and conduct research into breeding program design, such as implementation of genomic selection. Included is the 'Markovian Coalescent Simulator' ('MaCS') for fast simulation of biallelic sequences according to a population demographic history (Chen et al., 2009; https://doi.org/10.1101/gr.083634.108).

Publication

Gaynor, R. Chris, Gregor Gorjanc, and John M. Hickey. 2021. AlphaSimR: an R package for breeding program simulations. G3 Gene|Genomes|Genetics 11(2):jkaa017. https://doi.org/10.1093/g3journal/jkaa017.

Download

AlphaSimR is available on CRAN.

To install use:

install.packages('AlphaSimR')

The development version of AlphaSimR (potentially unstable) can be accessed from the devel branch on GitHub.

To install use:

devtools::install_github(repo="gaynorr/AlphaSimR@devel")

To install with vignettes use:

devtools::install_github(repo="gaynorr/AlphaSimR@devel", build_vignettes=TRUE)

Copy Link

Version

Install

install.packages('AlphaSimR')

Monthly Downloads

1,482

Version

1.5.3

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Chris Gaynor

Last Published

December 1st, 2023

Functions in AlphaSimR (1.5.3)

RRBLUP_GCA

RR-BLUP GCA Model
RRBLUP_SCA2

RR-BLUP SCA Model 2
RawPop-class

Raw Population
TraitA-class

Additive trait
RRBLUP_GCA2

RR-BLUP GCA Model 2
RRBLUP_SCA

RR-BLUP SCA Model
RRBLUP_D

RR-BLUP Model with Dominance
RRsol-class

RR-BLUP Solution
TraitAEG-class

Additive, epistasis and GxE trait
TraitADG-class

Additive, dominance and GxE trait
SimParam

Simulation parameters
TraitAE-class

Additive and epistatic trait
RRBLUP_D2

RR-BLUP with Dominance Model 2
TraitADEG-class

Additive, dominance, epistasis, and GxE trait
TraitAD-class

Additive and dominance trait
TraitADE-class

Additive, dominance, and epistatic trait
calcGCA

Calculate GCA
.newPop

Create new population (internal)
ebv

Estimated breeding value
editGenome

Edit genome
doubleGenome

Double the ploidy of individuals
aa

Additive-by-additive epistatic deviations
editGenomeTopQtl

Edit genome - the top QTL
addSegSite

Add segregating site to MapPop
TraitAG-class

Additive and GxE trait
bv

Breeding value
fastRRBLUP

Fast RR-BLUP
cChr

Combine MapPop chromosomes
newEmptyPop

Creates an empty population
nInd

Number of individuals
hybridCross

Hybrid crossing
TraitA2-class

Sex specific additive trait
attrition

Lose individuals at random
genicVarA

Additive genic variance
isFemale

Test if individuals of a population are female or male
genParam

Sumarize genetic parameters
importGenMap

Import genetic map
pullMarkerHaplo

Pull marker haplotypes
pedigreeCross

Pedigree cross
makeCross2

Make designed crosses
makeCross

Make designed crosses
newPop

Create new population
getPed

Get pedigree
genicVarAA

Additive-by-additive genic variance
meanP

Mean phenotypic values
genicVarG

Total genic variance
dd

Dominance deviations
pullIbdHaplo

Pull IBD haplotypes
randCross

Make random crosses
pullQtlHaplo

Pull QTL haplotypes
genicVarD

Dominance genic variance
TraitA2D-class

Sex specific additive and dominance trait
getQtlMap

Get QTL genetic map
isPop

Test if object is of a Population class
getMisc

Get miscelaneous information in a population
pullMarkerGeno

Pull marker genotypes
getNumThreads

Number of available threads
randCross2

Make random crosses
pullSnpHaplo

Pull SNP haplotypes
self

Self individuals
pullSegSiteGeno

Pull segregating site genotypes
selectOP

Select open pollinating plants
pullQtlGeno

Pull QTL genotypes
mergeGenome

Combine genomes of individuals
popVar

Population variance
smithHazel

Calculate Smith-Hazel weights
selectWithinFam

Select individuals within families
pheno

Phenotype
setPhenoProgTest

Set progeny test as phenotype
pullSegSiteHaplo

Pull seg site haplotypes
importInbredGeno

Import inbred, diploid genotypes
importHaplo

Import haplotypes
getGenMap

Get genetic map
varG

Total genetic variance
varP

Phenotypic variance
solveRRBLUP_EM2

Solve RR-BLUP with EM and 2 random effects
setEBV

Set EBV
selectInd

Select individuals
solveRRBLUP_EM3

Solve RR-BLUP with EM and 3 random effects
pullSnpGeno

Pull SNP genotypes
selectFam

Select families
setPheno

Set phenotypes
mutate

Add Random Mutations
reduceGenome

Create individuals with reduced ploidy
gv

Genetic value
sampleHaplo

Sample haplotypes from a MapPop
mergePops

Merge list of populations
getSnpMap

Get SNP genetic map
resetPop

Reset population
setPhenoGCA

Set GCA as phenotype
solveRRBLUP

Solve RR-BLUP
solveRRBLUPMK

Solve Multikernel RR-BLUP
quickHaplo

Quick founder haplotype simulation
selInt

Selection intensity
selectCross

Select and randomly cross
solveMKM

Solve Multikernel Model
solveUVM

Solve Univariate Model
selIndex

Selection index
solveMVM

Solve Multivariate Model
varA

Additive variance
usefulness

Usefulness criterion
varAA

Additive-by-additive epistatic variance
transMat

Linear transformation matrix
varD

Dominance variance
makeDH

Generates DH lines
solveRRBLUPMV

Solve Multivariate RR-BLUP
newMapPop

New MapPop
runMacs2

Alternative wrapper for MaCS
runMacs

Create founder haplotypes using MaCS
newMultiPop

Create new Multi Population
setMarkerHaplo

Set marker haplotypes
meanG

Mean genetic values
solveRRBLUP_EM

Solve RR-BLUP with EM
setMisc

Set miscelaneous information in a population
writeRecords

Write data records
writePlink

Writes a Pop-class as PLINK files
Pop-class

Population
RRBLUP

RR-BLUP Model
RRBLUP2

RR-BLUP Model 2
RRBLUPMemUse

RRBLUP Memory Usage
HybridPop-class

Hybrid population
AlphaSimR-package

AlphaSimR: Breeding Program Simulations
LociMap-class

Loci metadata
MapPop-class

Raw population with genetic map
MultiPop-class

Multi-Population
NamedMapPop-class

Raw population with genetic map and id