Learn R Programming

SIMplyBee README

SIMplyBee R package extends AlphaSimR for simulating honeybee populations and breeding programmes

Publication

Obšteter J., Strachan. L. K., Bubnič J., Prešern J., Gorjanc G. 2023. Genetics Selection Evolution, 55, 31. https://doi.org/10.1186/s12711-023-00798-y

Documentation

http://simplybee.info

Download

SIMplyBee is available on CRAN. You can install it with

install.packages(pkg = "SIMplyBee")

The development (and potentially unstable!) versions of SIMplyBee can be accessed from the main and devel GitHub branches using:

# New stable version of SIMplyBee before its submitted to CRAN
devtools::install_github(repo="HighlanderLab/SIMplyBee@main")

# Development version of SIMplyBee
devtools::install_github(repo="HighlanderLab/SIMplyBee@devel")

Copy Link

Version

Install

install.packages('SIMplyBee')

Monthly Downloads

263

Version

0.4.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Jana Obšteter

Last Published

September 20th, 2024

Functions in SIMplyBee (0.4.1)

SIMplyBee-package

SIMplyBee: 'AlphaSimR' Extension for Simulating Honeybee Populations and Breeding Programmes
calcBeeGRMIbd

Calculate Genomic Relatedness Matrix (GRM) for honeybees from Identical By Descent genomic data
MultiColony-class

Honeybee multicolony object
calcColonyValue

Calculate colony value(s)
calcBeeGRMIbs

Calculate Genomic Relatedness Matrix (GRM) for honeybees from Identical By State genomic data
calcInheritanceCriterion

Calculate the inheritance criterion
SimParamBee

Honeybee simulation parameters
buildUp

Build up Colony or MultiColony object by adding (raising) workers and drones
Colony-class

Honeybee colony
addCastePop

Add caste individuals to the colony
combine

Combine two colony objects
calcPerformanceCriterion

Calculate the performance criterion
calcSelectionCriterion

Calculate the selection criterion
combineBeeGametes

Create diploid gametes from a mated queen
createCastePop

Creates caste population individuals from the colony
c,NULLOrPop-method

Combine a NULL and AlphaSimR population
combineBeeGametesHaploDiploid

Create diploid gametes from a mated queen
collapse

Collapse
createColony

Create a new Colony
createMatingStationDCA

Create a DCA of drones at a mating stations
calcQueensPHomBrood

The expected proportion and a realised number of csd homozygous brood
createCrossPlan

Create a plan for crossing virgin queens
getAa

Access epistasis values of individuals in a caste
cross

Cross (mate) virgin queen(s) as a population, of a colony, or of all given colonies
createMultiColony

Create MultiColony object
downsize

Reduce number of workers and remove all drones and virgin queens from a Colony or MultiColony object
getCaste

Report caste of an individual
editCsdLocus

Edit the csd locus
downsizePUnif

Sample the downsize proportion - proportion of removed workers in downsizing
getCasteId

Get IDs of individuals of a caste, or ID of all members of colony
getEvents

Report which colony events have occurred
getBv

Access breeding values of individuals in a caste
getDd

Access dominance values of individuals in a caste
getCasteSex

Get sex of individuals of a caste, or sex of all members of colony
createDCA

Create a drone congregation area (DCA)
getCastePop

Access individuals of a caste
getQueenYearOfBirth

Access the queen's year of birth
getGv

Access genetic values of individuals in a caste
getIbdHaplo

Access IBD haplotypes of individuals in a caste
getSegSiteGeno

Access genotypes for all segregating sites of individuals in a caste
getPooledGeno

Get a pooled genotype from true genotypes
getQtlGeno

Access QTL genotypes of individuals in a caste
getSegSiteHaplo

Access haplotypes for all segregating sites of individuals in a caste
getPheno

Access phenotype values of individuals in a caste
isCsdHeterozygous

Test if individuals are heterozygous at the csd locus
getMisc

Get miscellaneous information in a population
isCsdActive

Is csd locus activated
getId

Get the colony ID
isCaste

Is individual a member of a specific caste
getLocation

Get the colony location
hasSwarmed

Test if colony has swarmed
getSnpGeno

Access SNP array genotypes of individuals in a caste
isProductive

Test if colony is currently productive
isNULLColonies

Check which of the colonies in a multicolony are NULL
isSimParamBee

Test if x is a SimParamBee class object
getSnpHaplo

Access SNP array haplotypes of individuals in a caste
isQueenPresent

Is the queen present
hasCollapsed

Test if colony has collapsed
pullCastePop

Pull individuals from a caste in a colony
nDronesPoisson

Sample a number of drones
isWorkersPresent

Are workers present
isVirginQueensPresent

Are virgin queen(s) present
nCsdAlleles

Report the number of distinct csd alleles
nWorkersPoisson

Sample a number of workers
nColonies

Number of colonies in a MultiColony object
nCaste

Level 0 function that returns the number of individuals of a caste in a colony
getCsdAlleles

Get csd alleles
getQueenAge

Get (calculate) the queen's age
nFathersPoisson

Sample a number of fathers
isGenoHeterozygous

Test if a multilocus genotype is heterozygous
isFathersPresent

Are fathers present (=queen mated)
pullColonies

Pull out some colonies from the MultiColony object
nVirginQueensPoisson

Sample a number of virgin queens
pullDroneGroupsFromDCA

Pulls drone groups from a Drone Congregation Area (DCA)
removeColonies

Remove some colonies from the MultiColony object
replaceCastePop

Replace a proportion of caste individuals with new ones
reduceDroneHaplo

Reduce drone's double haplotypes to a single haplotype
getQtlHaplo

Access QTL haplotypes of individuals in a caste
getCsdGeno

Get genotypes from the csd locus
removeCastePop

Remove a proportion of caste individuals from a colony
setQueensYearOfBirth

Set the queen's year of birth
reQueen

Re-queen
mapCasteToColonyValue

Map caste member (individual) values to a colony value
swarmPUnif

Sample the swarm proportion - the proportion of workers that swarm
supersede

Supersede
isEmpty

Check whether a population, colony or a multicolony object has no individuals within
simulateHoneyBeeGenomes

Simulate the Honey bee genome
split

Split colony in two MultiColony
swarm

Swarm
splitPUnif

Sample the split proportion - proportion of removed workers in a managed split
pullInd

Pull individuals from a population
hasSuperseded

Test if colony has superseded
hasSplit

Test if colony has split
setLocation

Set colony location
isDronesPresent

Are drones present
reduceDroneGeno

Reduce drones' genotype to a single haplotype
setMisc

Set miscellaneous information in a population
mapLoci

Finds loci on a genetic map and return a list of positions
rcircle

Sample random points within a circle
resetEvents

Reset colony events
selectColonies

Select colonies from MultiColony object