Skip to main content

Crate joaju_pedigree

Crate joaju_pedigree 

Source
Expand description

§joaju-pedigree

A high-performance Rust library for pedigree modeling, kinship calculation, and clinical pedigree rendering conforming to NSGC/ACMG guidelines.

⚠️ Early Development Notice (pre-1.0 / alpha): This library is currently in early active development (0.1.0). It is NOT recommended for production use beyond experimental testing and research. APIs are subject to breaking changes prior to a stable 1.0.0 release.

§Quick Example

use joaju_pedigree::prelude::*;

let ped = Ped::nuclear(2).unwrap();
assert_eq!(ped.len(), 4);

let kin = KinshipMatrix::compute(&ped);
assert!((kin.get("1", "3").unwrap() - 0.25).abs() < 1e-6);

Re-exports§

pub use crate::core::AdoptionType;
pub use crate::core::ChildlessType;
pub use crate::core::Individual;
pub use crate::core::Ped;
pub use crate::core::PregnancyLossType;
pub use crate::core::Sex;
pub use crate::core::Status;
pub use crate::core::TwinType;
pub use crate::genetics::Genotype;
pub use crate::genetics::Marker;
pub use crate::genetics::MendelianError;
pub use crate::graph::break_loops;
pub use crate::graph::find_inbreeding_loops;
pub use crate::graph::has_inbreeding_loops;
pub use crate::graph::peeling_order;
pub use crate::graph::InbreedingLoop;
pub use crate::graph::LoopBreaker;
pub use crate::kinship::compute_kinship_matrix;
pub use crate::kinship::KinshipMatrix;
pub use crate::layout::LayoutOptions;
pub use crate::layout::PedLayout;
pub use crate::render::render_svg;
pub use crate::render::ClinicalSymbol;
pub use crate::render::RenderOptions;

Modules§

core
genetics
graph
kinship
layout
prelude
render

Functions§

version