{"id":20371805,"url":"https://github.com/biosustain/genomediff-node","last_synced_at":"2026-04-19T01:07:42.984Z","repository":{"id":57249666,"uuid":"47124122","full_name":"biosustain/genomediff-node","owner":"biosustain","description":"GenomeDiff (*.gd) file parser for Node.js","archived":false,"fork":false,"pushed_at":"2016-02-17T12:19:29.000Z","size":31,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-12-07T09:12:17.718Z","etag":null,"topics":["breseq","genomediff","genomics","parser"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/biosustain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-30T14:29:32.000Z","updated_at":"2016-04-18T16:06:08.000Z","dependencies_parsed_at":"2022-09-01T06:11:34.540Z","dependency_job_id":null,"html_url":"https://github.com/biosustain/genomediff-node","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/biosustain/genomediff-node","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biosustain%2Fgenomediff-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biosustain%2Fgenomediff-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biosustain%2Fgenomediff-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biosustain%2Fgenomediff-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/biosustain","download_url":"https://codeload.github.com/biosustain/genomediff-node/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biosustain%2Fgenomediff-node/sbom","scorecard":{"id":239375,"data":{"date":"2025-08-11","repo":{"name":"github.com/biosustain/genomediff-node","commit":"5e2d50b98c7464aacae05772ee96e412ae3ce6b1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}}]},"last_synced_at":"2025-08-17T06:23:39.764Z","repository_id":57249666,"created_at":"2025-08-17T06:23:39.764Z","updated_at":"2025-08-17T06:23:39.764Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31990579,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"ssl_error","status_checked_at":"2026-04-18T20:23:29.375Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["breseq","genomediff","genomics","parser"],"created_at":"2024-11-15T01:09:51.354Z","updated_at":"2026-04-19T01:07:42.935Z","avatar_url":"https://github.com/biosustain.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Genomediff\n\n![Travis build status](https://travis-ci.org/biosustain/genomediff-node.svg)\n\n\u003e Parses strings from files in the GenomeDiff format generated by the breseq variant caller for haploid microbial organisms.\n\n### Installation\n----------------\n```shell\n$(node bin)/npm install genomediff\n```\n**Note**: It has only been tested with Node 5.\n\n\n### Usage\n---------\n\n**GenomeDiff** strings are parsed using `GenomeDiff.parse(\u003cstring\u003e)`. The **GenomeDiff** object contains a `metadata` dict with the meta data, as well as `mutations`, `evidence` and `validation` lists, each containing records of that type. Records can be accessed through this list or by id using `GenomeDiff.parse(\u003cstring\u003e)[\u003cid\u003e]`. **GenomeDiff** is an iterable and iterating it will return all properties and records.\n\nFor accessing all the records you can use `GenomeDiff.parse('\u003cstring\u003e').values()` which returns an iterable but only with the `Record` types.\n\nFor accessing the parents of a specific mutation you can use the `parents` property available on each record:\n```js\nlet doc = GenomeDiff.parse('\u003cstring\u003e'); // a genomediff string\nlet someMutation = doc[12]; // mutation with id '12'\nsomeMutation.parents // this will lookup all the parents of the record with id `12` and return as an array of Records\n```\n\nIf you want to get an attribute from a parent record then you can use the `.get(\u003cattribute\u003e)` method available on the record to do so:\n```js\nlet doc = GenomeDiff.parse('\u003cstring\u003e'); // a genomediff string\nlet someMutation = doc[12]; // mutation with id '12'\nsomeMutation.get('coverage') // this will lookup all the parents of the record with id `12` and return the value of the attribute `coverage` if found on any of the parent records\n```\n\nIf used with node, you can use the following:\n```js\nvar GenomeDiff = require('genomediff').GenomeDiff;\nvar fs = require('fs');\nvar file = fs.readFileSync('\u003cpath\u003e', \"utf8\"); // path to your `.gd` file\nvar doc = GenomeDiff.parse(file);\n```\n\nIf used in a browser, use:\n```js\nimport {GenomeDiff} from 'genomediff';\nvar doc = GenomeDiff.parse('\u003cstring\u003e'); // a genomediff string\n```\n**Note**: Keep in mind that this package requires an ES6 environment in order to work.\n\n\n### Running Tests\n-----------------\nA full test suite can be run using `npm test`. If you wish to run tests on file change, use `jasmine-node dist/ --autotest --color --verbose`.\n\n### Development\n---------------\nWhen developing, use `tsc --watch` to build the `.ts` files on change. Alternatively, you can use `npm run build` if you do not wish to run the build on file change.\n\n**Note**: If you add new files or remove files, make sure to edit the `\"files\"` field in `tsconfig.json`:\n```js\n\"files\": [\n\t\"./typings/typings.d.ts\", // never remove this line\n\t// add more files after this line\n\t\"./src/parser.ts\",\n\t\"./src/parser.spec.ts\",\n\t\"./src/records.ts\",\n\t\"./src/records.spec.ts\",\n\t\"./src/gd.ts\",\n\t\"./src/gd.spec.ts\"\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiosustain%2Fgenomediff-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiosustain%2Fgenomediff-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiosustain%2Fgenomediff-node/lists"}