Skip to content

The Count helps you count sequence occurrences... One ah ah ah, two ah ah ah, three ah ah ah...

Notifications You must be signed in to change notification settings

sarahsummerfield/the_count

 
 

Repository files navigation

Our mascot

The Count CI

The Count

A tool for counting exact K-mer occurrences in a DNA or RNA sequence very, very quickly (where K=32).

Command Line Interface

the_count <haystack> <needles> <output> where the haystack is a FASTA file that contains sequences to be searched and the needles are a FASTA file that contains 32-mers to be searched for.

Developer Tooling

The Count is implemented in the Rust programming language and supports Rust 1.43 and later. Tooling instructions are below. They assume you already have the Rust toolchain installed. To do this, see https://rustup.rs.

  • Run unit tests: cargo test
  • Run the demo: cargo run
  • Create a release build (faster): cargo build --release, the binary will end up in target/release/
  • Format the code (do this before pushing): cargo fmt

To run the benchmarks, you will need to install hyperfine. On a Mac this can be done through Homebrew using brew install hyperfine. You can also use the setup-mac make target: make setup-mac.

Benchmarks may then be run with make benchmark. The default benchmark searches a file with 1 million auto-generated sequences for 999 auto-generated 32-mers.

Authors

About

The Count helps you count sequence occurrences... One ah ah ah, two ah ah ah, three ah ah ah...

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 42.2%
  • Jupyter Notebook 40.9%
  • Python 15.6%
  • Makefile 1.1%
  • Dockerfile 0.2%