hammerlab/vcf.js

Name: vcf.js

Owner: Hammer Lab

Description: A VCF parser and variant record model in JavaScript.

Created: 2014-05-20 19:14:32.0

Updated: 2017-11-21 13:46:00.0

Pushed: 2017-03-04 17:06:05.0

Homepage: null

Size: 2226

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

VCF.js

VCF.js is a library that can remotely load and parse VCF files, or JSON representations of them. It is used to manipulate and analyse genotype calls.

Documentation

Documentation can be found in DOCUMENTATION.md.

Using it

Example usage in test/ directory, just start a server in the root directory (e.g. python -m SimpleHTTPServer) and open index.html, then open a dev console and look at the data object, for example.

TODO
  1. Make sure this works seamlessly client-side and in the browser, and plays well with npm.
  2. Define schema for loading JSON VCF records.
  3. Enable adding to/streaming VCF records from the server to the vcf object.
  4. Make a VCF writer.

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.