https://github.com/bionode/bionode-blast
NodeJS API wrapping the NCBI BLAST Common URL API. WIP.
https://github.com/bionode/bionode-blast
api-client bioinformatics bionode nodejs tool
Last synced: about 1 month ago
JSON representation
NodeJS API wrapping the NCBI BLAST Common URL API. WIP.
- Host: GitHub
- URL: https://github.com/bionode/bionode-blast
- Owner: bionode
- Created: 2017-02-14T21:41:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-04T19:38:02.000Z (over 8 years ago)
- Last Synced: 2024-12-27T18:11:51.098Z (over 1 year ago)
- Topics: api-client, bioinformatics, bionode, nodejs, tool
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 20
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# bionode-blast
NodeJS API wrapping the NCBI BLAST [Common URL API](https://ncbi.github.io/blast-cloud/dev/api.html).
WIP.
Goals are to
- provide a (typed) JS API that makes it simpler to work NCBI BLAST
- probably Flow since it makes clean JS after flow-remove-types
- question: how to support Flow and TS type libraries/definitions?
- interporates well with other bionode modules: streams compatible (e.g. object stream of matches)
- CLI API
- express REST server wrapping JS API to provide a truly REST interface
- once finalized, illustrate interoperability with webapp/Electron/BioJS visualization modules
- e.g. Electron BLAST app that automatically stores results locally
TODO
- [ ] Only allow some params conditonal on other params
- e.g. description only allowed when report is Text/HTML
- [ ] Param validation
- [ ] Param description
- [ ] Param defaults
- [ ] Param defaults conditional on other params
- e.g. if program is blastp or blastn, change word size
- [ ] Configurable param defaults
- [ ] Response schema
- [ ] Typed params
- [ ] Typed response
- [ ] RAML/Swagger spec REST API, local wrapper server