npm install bionode-sam
bionode-sam (work in progress)
> A Node.js wrapper for the Burrow-Wheeler Aligner (BWA).
Install
-------
Install bionode-sam with npm:
``sh`
$ 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:
`sh`
$ npm test
Please also check for code coverage:
`sh`
$ npm run coverage
To rebuild the documentation using the comments in the code:
`sh``
$ npm run build-docs
Check the issues for ways to contribute.
Contacts
--------
Bruno Vieira <mail@bmpvieira.com> @bmpvieira
For samtools support check its repo.
License
-------
bionode-sam is licensed under the MIT license.
Check ChooseALicense.com for details.
[npm-url]: //npmjs.org/package/bionode-sam
[npm-image]: https://badge.fury.io/js/bionode-sam.png
[travis-url]: //travis-ci.org/bionode/bionode-sam
[travis-image]: https://travis-ci.org/bionode/bionode-sam.png?branch=master
[coveralls-url]: //coveralls.io/r/bionode/bionode-sam
[coveralls-image]: https://coveralls.io/repos/bionode/bionode-sam/badge.png
[depstat-url]: http://david-dm.org/bionode/bionode-sam
[depstat-image]: http://david-dm.org/bionode/bionode-sam.png
[doi-url]: http://dx.doi.org/
[doi-image]: https://zenodo.org/badge/xxxx/bionode/bionode-sam.png
