Expand description
rust support for demes.
§Introduction
This crate provides:
- Support for reading
YAML
descriptions ofdemes
models. Seeloads
andload
. - Support for building a demes model using
rust
code. SeeGraphBuilder
.
The output of any of these operations is a fully-resolved
Graph
.
§More information
- See here for
an overview of
demes
.
§Technical details
YAML
andGraphBuilder
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.
§Features
The following cargo features are available:
json
: enables reading/writing aGraph
in JSON format.
Modules§
- Define a foreign function interface (FFI) for this crate.
Structs§
- An asymmetric migration epoch.
- The cloning rate of an
Epoch
. - A resolved deme.
- Deme-level defaults
- 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
- Input value for
CloningRate
, used when loading or building graphs. - Input value for
DemeSize
, used when loading or building graphs. - Input value for
GenerationTime
, used when loading or building graphs. - Input value for
MigrationRate
, used when loading or building graphs. - Input value for
Proportion
, used when loading or building graphs. - Input value for
SelfingRate
, used when loading or building graphs. - Input value for
Time
, used when loading or building graphs. - 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)
. - Top-level defaults for a
Deme
. - HDM data for a
Deme
- HDM representation of an epoch.
- An unresolved migration epoch.
- An unresolved Pulse event.
Enums§
- Error type raised by
GraphBuilder
- A deme can be identified as an index or as a name
- Error type for this crate.
- Specify how deme sizes change during an
Epoch
. - The time units of a graph
Functions§
- Build a
Graph
from a type implementingstd::io::Read
. - load_json
json
Load aGraph
from a JSON reader. - loads_json
json
Generate aGraph
from a JSON string. - Convert a time value into generations, rounding output to closest integer.
- Return the package version given in the
Cargo.toml
file of this crate.