https://github.com/tskit-dev/tstrait

Quantitative trait simulation for ARGs
https://github.com/tskit-dev/tstrait

args tree-sequences tskit

Last synced: 3 months ago
JSON representation

Quantitative trait simulation for ARGs

• Host: GitHub
• URL: https://github.com/tskit-dev/tstrait
• Owner: tskit-dev
• License: mit
• Created: 2023-03-23T16:30:26.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-09-29T14:04:31.000Z (7 months ago)
• Last Synced: 2025-12-08T11:47:56.016Z (5 months ago)
• Topics: args, tree-sequences, tskit
• Language: Python
• Homepage: https://tskit.dev/software/tstrait
• Size: 1.67 MB
• Stars: 8
• Watchers: 6
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tstrait

[![License](https://img.shields.io/github/license/tskit-dev/tstrait)](https://github.com/tskit-dev/tstrait/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/tstrait.svg)](https://pypi.org/project/tstrait/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/tstrait.svg)](https://pypi.org/project/tstrait/) [![Docs Build](https://github.com/tskit-dev/tstrait/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/tstrait/actions/workflows/docs.yml) [![Binary wheels](https://github.com/tskit-dev/tstrait/actions/workflows/wheels.yml/badge.svg)](https://github.com/tskit-dev/tstrait/actions/workflows/wheels.yml) [![Tests](https://github.com/tskit-dev/tstrait/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/tstrait/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/tstrait/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/tstrait)

**tstrait** is a quantitative trait simulator of [tskit](https://tskit.dev) tree sequences. It supports simulation of quantitative traits, sampling genetic effect sizes from various distributions, modelling pleiotropic phenotypes and environmental noise, and computing per‑individual genetic values given the effect sizes of causal mutations.

Documentation: https://tskit.dev/tstrait/docs/stable/ (latest: https://tskit.dev/tstrait/docs/latest/)

Learn more about tree sequences: https://tskit.dev/learn/

## Installation

```bash

python -m pip install tstrait

# or

conda install -c conda-forge tstrait

```

## Quickstart

See the documentation quickstart and examples: https://tskit.dev/tstrait/docs/stable/