https://github.com/bionode/bionode-fastq

Streamable FASTQ parser
https://github.com/bionode/bionode-fastq

bioinformatics bionode nodejs parser tool

Last synced: about 1 year ago
JSON representation

Streamable FASTQ parser

• Host: GitHub
• URL: https://github.com/bionode/bionode-fastq
• Owner: bionode
• License: mit
• Created: 2015-04-08T17:46:53.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-10-04T21:17:51.000Z (over 8 years ago)
• Last Synced: 2025-04-19T00:25:21.394Z (about 1 year ago)
• Topics: bioinformatics, bionode, nodejs, parser, tool
• Language: JavaScript
• Homepage: bionode.io
• Size: 25.2 MB
• Stars: 2
• Watchers: 19
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


  

    

  

  


  bionode.io



# bionode-fastq

> Streamable FASTQ parser.

[![npm](https://img.shields.io/npm/v/bionode-fastq.svg?style=flat-square)](http://npmjs.org/package/bionode-fastq)

[![Travis](https://img.shields.io/travis/bionode/bionode-fastq.svg?style=flat-square)](https://travis-ci.org/bionode/bionode-fastq)

[![Coveralls](https://img.shields.io/coveralls/bionode/bionode-fastq.svg?style=flat-square)](http://coveralls.io/r/bionode/bionode-fastq)

[![Dependencies](http://img.shields.io/david/bionode/bionode-fastq.svg?style=flat-square)](http://david-dm.org/bionode/bionode-fastq)

[![npm](https://img.shields.io/npm/dt/bionode-fastq.svg?style=flat-square)](https://www.npmjs.com/package/bionode-fastq)

[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/bionode/bionode)

## Install

You need to install the latest Node.JS first, please check [nodejs.org](http://nodejs.org) or do the following:

```bash

# Ubuntu

sudo apt-get install npm

# Mac

brew install node

# Both

npm install -g n

n stable

```

To use `bionode-fastq` as a command line tool, you can install it globally with `-g`.

```bash

npm install bionode-fastq -g

```

Or, if you want to use it as a JavaScript library, you need to install it in your local project folder inside the `node_modules` directory by doing the same command **without** `-g`.

```bash

npm i bionode-fastq # 'i' can be used as shorcut to 'install'

```

## Documentation

Check our documentation at [doc.bionode.io](http://doc.bionode.io) or do:

```bash

bionode-fastq --help

```

## Contributing

We welcome all kinds of contributions at all levels of experience, please read the [CONTRIBUTING.md](CONTRIBUTING.md) to get started!

## Communication channels

Don't be shy! Come talk to us :smiley:

* **Email** [mail@bionode.io](mailto:mail@bionode.io)

* **Chat room** [http://gitter.im/bionode/bionode](http://gitter.im/bionode/bionode)

* **IRC** #bionode on Freenode

* **Twitter** [@bionode](http://twitter.com/@bionode)