nj 0.0.21

Neighbor-Joining phylogenetic tree inference. Auto-detects DNA/protein, supports multiple substitution models and bootstrap.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Error type for the `nj` library.

use crate::alphabet::Alphabet;
use crate::models::SubstitutionModel;
use std::fmt;

/// Errors that can occur during Neighbor-Joining analysis.
#[derive(Debug)]
pub enum NJError {
    /// The input MSA contains no sequences.
    EmptyMsa,
    /// A sequence in the MSA has zero length.
    EmptySequence,
    /// Sequences in the MSA have different lengths.
    SequenceLengthMismatch {
        expected: usize,
        got: usize,
        identifier: String,
    },
    /// The substitution model is incompatible with the detected or specified alphabet.
    IncompatibleModel {
        model: SubstitutionModel,
        alphabet: Alphabet,
    },
    /// An internal NJ algorithm failure (should be unreachable for valid input).
    AlgorithmFailure(String),
    /// Failed to collect entropy from the OS PRNG (bootstrap only).
    RngError(String),
    /// Failed to parse a FASTA-formatted string.
    ParseError(String),
}

impl fmt::Display for NJError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            NJError::EmptyMsa => write!(f, "Input MSA is empty"),
            NJError::EmptySequence => write!(f, "Sequences must not be empty"),
            NJError::SequenceLengthMismatch { expected, got, identifier } => write!(
                f,
                "All sequences must have the same length. Expected {expected}, got {got} for '{identifier}'"
            ),
            NJError::IncompatibleModel { model, alphabet } => write!(
                f,
                "Substitution model {model:?} is incompatible with {alphabet:?} alphabet"
            ),
            NJError::AlgorithmFailure(msg) => write!(f, "NJ algorithm failure: {msg}"),
            NJError::RngError(msg) => write!(f, "RNG error: {msg}"),
            NJError::ParseError(msg) => write!(f, "FASTA parse error: {msg}"),
        }
    }
}

impl std::error::Error for NJError {}