This package has been deprecated

Author message:

This package is deprecated, pending review of 0.1.0

kmer.js

0.0.3 • Public • Published

README - Kmer.js

A Javascript/NodeJS package for shredding strings into all possible substrings of length 'k'

NPM Version NPM Downloads Linux Build Test Coverage

Kmer.js is a NodeJS package designed for data/science applications. It addresses the 'k-mer' problem(substrings of length from a string) in a simple and performant manner. This library produces all of the n - k + 1 substrings of length k from a string of length n.

Installation

OS X & Linux:

npm install --save kmer.js

Usage Example

>var kmers = require('kmer.js');
>var fourmers = kmers("hello world!", 4)
[ 'hell',
'ello',
'llo ',
'lo w',
'o wo',
' wor',
'worl',
'orld',
'rld!' ]

Develoment

npm test # MochaJS specs
npm run-script bench # benchmark.js performance tests, varying n and k

License

Created by Matthew Ralston - Scientist, Programmer, Musician - Email

Distributed under the GPL v3.0 license. See LICENSE.txt for the copy distributed with this project. Open source software is not for everyone, but for those of us starting out and trying to put the ecosystem ahead of ego, we march into the information age with this ethos.

https://github.com/MatthewRalston/kmer.js

Contributing

  1. Fork it (https://github.com/MatthewRalston/kmer.js/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Package Sidebar

Install

npm i kmer.js

Weekly Downloads

3

Version

0.0.3

License

GPL-3.0

Last publish

Collaborators

  • matthewralston