{"id":18666788,"url":"https://github.com/bionode/bionode-vcf","last_synced_at":"2026-02-26T08:13:29.930Z","repository":{"id":74495709,"uuid":"47397285","full_name":"bionode/bionode-vcf","owner":"bionode","description":"vcf parser using javascript","archived":false,"fork":false,"pushed_at":"2018-03-22T17:56:13.000Z","size":47,"stargazers_count":5,"open_issues_count":5,"forks_count":7,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-04-13T16:34:12.759Z","etag":null,"topics":["bioinformatics","bionode","nodejs","parser","tool"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bionode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-04T10:25:04.000Z","updated_at":"2023-07-16T00:55:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"c51c0920-28bf-48a6-809c-e5061a4f7f75","html_url":"https://github.com/bionode/bionode-vcf","commit_stats":{"total_commits":27,"total_committers":8,"mean_commits":3.375,"dds":0.6666666666666667,"last_synced_commit":"1a92333782e0b2c518134ee3c1d5d9adec3c0692"},"previous_names":["shyamrallapalli/biojs-vcf"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-vcf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-vcf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-vcf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bionode%2Fbionode-vcf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bionode","download_url":"https://codeload.github.com/bionode/bionode-vcf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248087671,"owners_count":21045562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bioinformatics","bionode","nodejs","parser","tool"],"created_at":"2024-11-07T08:34:02.724Z","updated_at":"2026-02-26T08:13:24.910Z","avatar_url":"https://github.com/bionode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://bionode.io\"\u003e\n    \u003cimg height=\"200\" width=\"200\" title=\"bionode\" alt=\"bionode logo\" src=\"https://rawgithub.com/bionode/bionode/master/docs/bionode-logo.min.svg\"/\u003e\n  \u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"http://bionode.io/\"\u003ebionode.io\u003c/a\u003e\n\u003c/p\u003e\n\n\n# bionode-vcf\n\n\u003e a vcf parser in javascript\n\n[![npm](https://img.shields.io/npm/v/bionode-vcf.svg?style=flat-square)](http://npmjs.org/package/bionode-vcf)\n[![Travis](https://img.shields.io/travis/bionode/bionode-vcf.svg?style=flat-square)](https://travis-ci.org/bionode/bionode-vcf)\n[![Coveralls](https://img.shields.io/coveralls/bionode/bionode-vcf.svg?style=flat-square)](http://coveralls.io/r/bionode/bionode-vcf)\n[![Dependencies](http://img.shields.io/david/bionode/bionode-vcf.svg?style=flat-square)](http://david-dm.org/bionode/bionode-vcf)\n[![npm](https://img.shields.io/npm/dt/bionode-vcf.svg?style=flat-square)](https://www.npmjs.com/package/bionode-vcf)\n[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/bionode/bionode)\n\n\n## Install\n\nYou need to install the latest Node.JS first, please check [nodejs.org](http://nodejs.org) or do the following:\n\n```bash\n# Ubuntu\nsudo apt-get install npm\n# Mac\nbrew install node\n# Both\nnpm install -g n\nn stable\n```\n\nTo use `bionode-vcf` as a command line tool, you can install it globally with `-g`.\n\n```bash\nnpm install bionode-vcf -g\n```\n\nOr, 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`.\n\n```bash\nnpm i bionode-vcf # 'i' can be used as shortcut to 'install'\n```\n\n\n### Usage\n\n#### vcf.read\n- `vcf.read` takes params: `path`\n- The supported filetypes are `vcf`, `zip` and `gz`.\n\n```javascript\nvar vcf = require('bionode-vcf');\nvcf.read(\"/path/sample.vcf\");\nvcf.on('data', function(feature){\n    console.log(feature);\n})\n\nvcf.on('end', function(){\n    console.log('end of file')\n})\n\nvcf.on('error', function(err){\n    console.error('it\\'s not a vcf', err)\n})\n\n```\n\n#### vcf.readStream\n- `vcf.readStream` takes params: `stream` and `extension`\n- The supported extension are `vcf`, `zip` and `gz`.\n\n```javascript\nvar vcf = require('bionode-vcf');\nvar fileStream = s3.getObject({\n    Bucket: [BUCKETNAME],\n    Key: [FILENAME]\n}).createReadStream();  // or stream data from any other source\n\nvcf.read(filestream, 'zip'); // default value is `vcf`\nvcf.on('data', function(feature){\n    console.log(feature);\n})\n\nvcf.on('end', function(){\n    console.log('end of file')\n})\n\nvcf.on('error', function(err){\n    console.error('it\\'s not a vcf', err)\n})\n\n```\n\n## Documentation\n\nVCF format specifications and more information about the fileds can be found at\n[1000 genomes webpage](http://www.1000genomes.org/wiki/analysis/variant%20call%20format/vcf-variant-call-format-version-41) and\n[samtools github page](https://github.com/samtools/hts-specs)\n\n\n## Contributing\n\nWe welcome all kinds of contributions at all levels of experience, please read the [CONTRIBUTING.md](CONTRIBUTING.md) to get started!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbionode%2Fbionode-vcf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbionode%2Fbionode-vcf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbionode%2Fbionode-vcf/lists"}