kinship.exp: Derive expected kinship

In MoBPS: Modular Breeding Program Simulator

Derive expected kinship

Description

Function to derive expected kinship

Usage

kinship.exp(
  population,
  gen = NULL,
  database = NULL,
  cohorts = NULL,
  depth.pedigree = 7,
  start.kinship = NULL,
  elements = NULL,
  mult = 1,
  storage.save = 1.05,
  verbose = TRUE,
  include.error = TRUE,
  elements.copy = FALSE
)

Arguments

population	Population list
gen	Quick-insert for database (vector of all generations to export)
database	Groups of individuals to consider for the export
cohorts	Quick-insert for database (vector of names of cohorts to export)
depth.pedigree	Depth of the pedigree in generations
start.kinship	Relationship matrix of the individuals in the first considered generation
elements	Vector of individuals from the database to include in pedigree matrix
mult	Multiplicator of kinship matrix (default: 1; set to 2 for a pedigree relationship matrix)
storage.save	Lower numbers will lead to less memory but slightly higher computing time (default: 1.5, min: 1)
verbose	Set to FALSE to not display any prints
include.error	Set to FALSE to ignore/correct any errors in the pedigree
elements.copy	Set to TRUE to automatically remove duplicated entries for individuals/database from the output matrix (default: FALSE)

Value

Pedigree-based kinship matrix for in gen/database/cohort selected individuals

Examples

data(ex_pop)
kinship <- kinship.exp(population=ex_pop, gen=2)

MoBPS documentation built on Nov. 5, 2025, 6:26 p.m.