/Kmers.jl

In development: Kmer types and methods for julia

Primary LanguageJuliaMIT LicenseMIT

Kmers

Latest Release MIT license Documentation Pkg Status

Description

Kmers provides a specialised concrete BioSequence subtype, optimised for representing short immutable sequences called kmers: contiguous sub-strings of k nucleotides of some reference sequence.

They are used extensively in bioinformatic analyses as an informational unit. This concept was popularised by short read assemblers. Analyses within the kmer space benefit from a simple formulation of the sampling problem and direct in-hash comparisons.

Kmers provides the type representing kmers as well as the implementations of the APIs specified by the BioSequences.jl package.

Installation

You can install BioSequences from the julia REPL. Press ] to enter pkg mode, and enter the following:

add Kmers

If you are interested in the cutting edge of the development, please check out the master branch to try new features before release.

Testing

Kmers is tested against Julia 1.X on Linux, OS X, and Windows.

Unit tests Documentation

Contributing

We appreciate contributions from users including reporting bugs, fixing issues, improving performance and adding new features.

Take a look at the contributing files detailed contributor and maintainer guidelines, and code of conduct.

Questions?

If you have a question about contributing or using BioJulia software, come on over and chat to us on Gitter, or you can try the Bio category of the Julia discourse site.