Skip to main content

Crate use_residue

Crate use_residue 

Source
Expand description

§use-residue

Primitive residue vocabulary.

use-residue describes single biological residue symbols generically across nucleotide and amino-acid sequences. It supports gap and ambiguous residues, but does not infer chemistry, translate residues, score substitutions, or implement alignment algorithms.

use use_residue::{Residue, ResidueKind};

let gap = Residue::gap();
let ambiguous = Residue::new('N', ResidueKind::Ambiguous);

assert_eq!(gap.symbol().as_char(), '-');
assert_eq!(ambiguous.kind(), &ResidueKind::Ambiguous);

Structs§

Residue
A single residue symbol with a descriptive kind.
ResidueSymbol
A single residue symbol.

Enums§

ResidueError
Error returned by residue vocabulary constructors.
ResidueKind
A descriptive kind for a biological residue.