Crate demes

source · [−]

Expand description

rust support for demes.

Introduction

This crate provides:

Support for reading YAML descriptions of demes models. See loads and load.
Support for building a demes model using rust code. See GraphBuilder.

The output of any of these operations is a fully-resolved Graph.

More information

See here for an overview of demes.

Technical details

YAML and GraphBuilder inputs support the Human Data Model (HDM) described in the demes specification
A Graph is fully-resolved according to the Machine Data Model (MDM) described in the specification.

Known limitations

There are currently no convenience functions for exporting a Graph back into YAML. However, this task is easily done via serde_yaml::to_string.

Structs

AsymmetricMigration

An asymmetric migration epoch.

The cloning rate of an Epoch.

A resolved deme.

Deme-level defaults

The size of a Deme at a given Time.

A resolved epoch

Generation time.

A resolved demes Graph.

This type allows building a Graph using code rather then using text input.

Top-level defaults

Top-level metadata

A migration rate.

An ancestry proportion.

A resolved Pulse event

The selfing rate of an Epoch.

Store time values.

A half-open time interval [present, past).

TopLevelDemeDefaults

Top-level defaults for a Deme.

UnresolvedDemeHistory

HDM data for a Deme

UnresolvedEpoch

HDM representation of an epoch.

UnresolvedMigration

An unresolved migration epoch.

UnresolvedPulse

An unresolved Pulse event.

Enums

Error type for this crate.

RoundTimeToInteger

Specify rounding method for Graph::to_integer_generations

Specify how deme sizes change during an Epoch.

The time units of a graph

Functions

Build a Graph from a type implementing Read.

Build a Graph from an in-memory str.

Return the package version given in the Cargo.toml file of this crate.