Submodule organizationΒΆ

xftsim is organized into a number of submodules, the contents of which are arranged as follows:

submodule

contents

tutorials

arch

Phenogenetic archtectures and components thereof

effect

Genetic effects

founders

Creating and importing founder haplotypes

index

Indices for working with individual-, variant-, and component-level data

io

Routines for reading and writing data to disk

mate

Mating regimes and the MateAssignment class

ped

Pedigree data stuctures

proc

Data post-processors (saving intermediate simulation data, limiting memory, etc.)

reproduce

Reproduction and transmission of genetic and phenotypic data

sim

Simulation class for setting up and running experiments

stats

Statistical estimators

struct

Basic data structures for working with genotype and phenotype data

utils

Utility functions and profiling