bionode-sam

bionode.io

# bionode-sam (*work in progress*)

A Node.js wrapper for the Burrow-Wheeler Aligner (BWA).

Install

Install bionode-sam with npm:

$ npm install bionode-sam

To use it as a command line tool, you can install it globally by adding -g .

Usage

This module is still a work in progress, so you shouldn't be using it unless you know what you're doing.

Contributing

To contribute, clone this repo locally and commit your code on a separate branch.

Please write unit tests for your code, and check that everything works by running the following before opening a pull-request:

$ npm test

Please also check for code coverage:

$ npm run coverage

To rebuild the documentation using the comments in the code:

$ npm run build-docs

Check the issues for ways to contribute.

Contacts

Bruno Vieira <[e-mail]> @bmpvieira
For samtools support check its repo.

License

bionode-sam is licensed under the MIT license.
Check ChooseALicense.com for details.