Learn R Programming

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.6.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Chris Gaynor

Last Published

August 17th, 2024

Functions in AlphaSimR (1.6.0)

RRsol-class

RR-BLUP Solution
RRBLUP_SCA

RR-BLUP SCA Model
RRBLUP_SCA2

RR-BLUP SCA Model 2
RawPop-class

Raw Population
RRBLUP_GCA

RR-BLUP GCA Model
TraitADE-class

Additive, dominance, and epistatic trait
RRBLUP_GCA2

RR-BLUP GCA Model 2
TraitAD-class

Additive and dominance trait
TraitAEG-class

Additive, epistasis and GxE trait
.newPop

Create new population (internal)
addSegSite

Add segregating site to MapPop
doubleGenome

Double the ploidy of individuals
TraitAE-class

Additive and epistatic trait
attrition

Lose individuals at random
RRBLUP_D

RR-BLUP Model with Dominance
TraitADEG-class

Additive, dominance, epistasis, and GxE trait
genicVarAA

Additive-by-additive genic variance
genicVarD

Dominance genic variance
TraitADG-class

Additive, dominance and GxE trait
dd

Dominance deviations
calcGCA

Calculate GCA
SimParam

Simulation parameters
isPop

Test if object is of a Population class
makeCross

Make designed crosses
importGenMap

Import genetic map
importHaplo

Import haplotypes
TraitA2D-class

Sex specific additive and dominance trait
TraitA2-class

Sex specific additive trait
bv

Breeding value
TraitA-class

Additive trait
mergePops

Merge list of populations
RRBLUP_D2

RR-BLUP with Dominance Model 2
TraitAG-class

Additive and GxE trait
getNumThreads

Number of available threads
aa

Additive-by-additive epistatic deviations
meanEBV

Mean estimated breeding values
newPop

Create new population
cChr

Combine MapPop chromosomes
meanG

Mean genetic values
genicVarA

Additive genic variance
genicVarG

Total genic variance
genParam

Sumarize genetic parameters
meanP

Mean phenotypic values
pullSegSiteHaplo

Pull seg site haplotypes
pedigreeCross

Pedigree cross
ebv

Estimated breeding value
getPed

Get pedigree
mergeGenome

Combine genomes of individuals
editGenome

Edit genome
fastRRBLUP

Fast RR-BLUP
editGenomeTopQtl

Edit genome - the top QTL
getQtlMap

Get QTL genetic map
getSnpMap

Get SNP genetic map
pullSnpGeno

Pull SNP genotypes
pheno

Phenotype
makeCross2

Make designed crosses
makeDH

Generates DH lines
mutate

Add Random Mutations
importInbredGeno

Import inbred, diploid genotypes
getGenMap

Get genetic map
gv

Genetic value
pullMarkerHaplo

Pull marker haplotypes
hybridCross

Hybrid crossing
pullQtlGeno

Pull QTL genotypes
newEmptyPop

Creates an empty population
nInd

Number of individuals
isFemale

Test if individuals of a population are female or male
pullIbdHaplo

Pull IBD haplotypes
newMapPop

New MapPop
runMacs

Create founder haplotypes using MaCS
randCross

Make random crosses
pullMarkerGeno

Pull marker genotypes
runMacs2

Alternative wrapper for MaCS
setEBV

Set estimated breeding values (EBV)
transMat

Linear transformation matrix
self

Self individuals
randCross2

Make random crosses
popVar

Population variance
usefulness

Usefulness criterion
reduceGenome

Create individuals with reduced ploidy
sampleHaplo

Sample haplotypes from a MapPop
newMultiPop

Create new Multi Population
smithHazel

Calculate Smith-Hazel weights
solveMKM

Solve Multikernel Model
pullSegSiteGeno

Pull segregating site genotypes
selIndex

Selection index
pullQtlHaplo

Pull QTL haplotypes
selectOP

Select open pollinating plants
solveRRBLUP_EM3

Solve RR-BLUP with EM and 3 random effects
resetPop

Reset population
solveUVM

Solve Univariate Model
selectWithinFam

Select individuals within families
pullSnpHaplo

Pull SNP haplotypes
setMarkerHaplo

Set marker haplotypes
setPheno

Set phenotypes
selectFam

Select families
solveRRBLUPMV

Solve Multivariate RR-BLUP
solveRRBLUPMK

Solve Multikernel RR-BLUP
varA

Additive variance
varAA

Additive-by-additive epistatic variance
selectInd

Select individuals
quickHaplo

Quick founder haplotype simulation
selInt

Selection intensity
selectCross

Select and randomly cross
varG

Total genetic variance
varP

Phenotypic variance
varD

Dominance variance
setPhenoGCA

Set GCA as phenotype
setPhenoProgTest

Set progeny test as phenotype
solveRRBLUP_EM2

Solve RR-BLUP with EM and 2 random effects
solveRRBLUP_EM

Solve RR-BLUP with EM
varEBV

Variance of estimated breeding values
solveMVM

Solve Multivariate Model
writePlink

Writes a Pop-class as PLINK files
solveRRBLUP

Solve RR-BLUP
writeRecords

Write data records
RRBLUP2

RR-BLUP Model 2
AlphaSimR-package

AlphaSimR: Breeding Program Simulations
NamedMapPop-class

Raw population with genetic map and id
LociMap-class

Loci metadata
MapPop-class

Raw population with genetic map
MultiPop-class

Multi-Population
RRBLUPMemUse

RRBLUP Memory Usage
RRBLUP

RR-BLUP Model
HybridPop-class

Hybrid population
Pop-class

Population