seal
Synopsis
A Rust implementation of Needleman-Wunsch & Smith-Waterman sequence alignment.
Motivation
The aim of this crate is to provide a memory- and time-efficient implementation of Needleman-Wunsch as well as Smith-Waterman sequence alignment using a unified API.
Getting Started
Add the most recent version of seal
to your dependencies in your project's Cargo.toml
.
Then add …
extern crate seal;
… to your crate's root file (e.g. lib.rs
, main.rs
).
Once that's done you're ready to play!
Example
extern crate seal;
use ;
See the examples directory for more in-depth examples.
API Reference
An AlignmentSet
contains all optimal alignments for a given pair of sequences.
Retrieving a single locally/globally optimal alignment
let alignment in alignment_set.local_alignment;
let alignment in alignment_set.global_alignment;
Enumerate all locally/globally optimal alignments
for alignment in alignment_set.local_alignments
for alignment in alignment_set.global_alignments
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
License
This project is licensed under the MPL-2.0 – see the LICENSE.md file for details.