create_iso_female: function to simulate creation of an isofemale line

In thijsjanzen/GenomeAdmixR: Simulate Admixture of Genomes

function to simulate creation of an isofemale line

Description

create_isofemale simulates the creation of an isofemale line through extreme inbreeding.

Usage

create_iso_female(
  module = ancestry_module(),
  n = 1,
  inbreeding_pop_size = 100,
  run_time = 2000,
  num_threads = 1,
  verbose = FALSE
)

Arguments

module	Source population from which isofemales are generated
n	Number of isofemales to be generated
inbreeding_pop_size	Population size of the population used to generate homozygous individuals
run_time	Maximum runtime used for inbreeding
num_threads	number of threads. Default is 1. Set to -1 to use all available threads
verbose	Displays verbose output if TRUE. Default value is FALSE

Details

To create an isofemale, two individuals are randomly picked from the source population. Using these two individuals, a new population is seeded, of size inbreeding_pop_size. Then, this population is allowed to inbreed until either run_time is reached, or until all individuals are homozygous and genetically identical, whatever happens first.

Value

A list of length n, where each entry is a fully homozygous isofemale.

thijsjanzen/GenomeAdmixR documentation built on Feb. 16, 2024, 7:27 p.m.