Skip to content

Commit

Permalink
Merge branch 'main' of github.com:jeff-k/bio-seq
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-k committed Jan 12, 2025
2 parents 43c048a + a9fab70 commit 2c750cc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ Many bioinformatics crates implement their own kmer packing logic. This effort b

Some people like to engineer clever bit twiddling hacks to reverse complement a sequence and some people want to rapidly prototype succinct datastructures. Most people don't want to worry about endianess. The strength of rust is that we can safely abstract the science from the engineering to work towards both objectives.

Benchmarking is a useful tool for tracking assumptions about program behaviour and keeping fun hacks realistic (the "trees") but the primary design goal for this crate is to define traits that allow us to reason about these datastructures safely and consistently (the "forest".) We should be able to incrementally introduce optimisations without breaking the API.
## Contributing

Contributions are very welcome. There's lots of low hanging fruit for optimisations and ideally we should only have to write them once!
Contributions and suggestions are very much welcome. Check out the [Roadmap](https://github.com/jeff-k/bio-seq/issues/10) to get started.

## Contents

Expand Down Expand Up @@ -384,6 +384,4 @@ impl TranslationTable<Dna, Amino> for Mitochondria {
}
```

## Contributing

Contributions and suggestions are very much welcome. The easiest way to begin contributing is through github issues.
2 changes: 1 addition & 1 deletion bio-seq/examples/seq2bin.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! This example demonstrates how to safe bio-seq sequences to binary files
//! This example demonstrates how to save bio-seq sequences to binary files
//!
//! It encodes amino acid or DNA sequences from the first record of a fasta file
//! and saves them to a binary file along with metadata about the encoding
Expand Down

0 comments on commit 2c750cc

Please sign in to comment.