https://github.com/sing-group/biojs-vis-blasterjs
BlasterJS - an open source JS library to display Blast results
https://github.com/sing-group/biojs-vis-blasterjs
biojs blast blast-output-viewer bootstrap html2canvas javascript npm
Last synced: about 1 year ago
JSON representation
BlasterJS - an open source JS library to display Blast results
- Host: GitHub
- URL: https://github.com/sing-group/biojs-vis-blasterjs
- Owner: sing-group
- License: other
- Created: 2016-07-13T09:39:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-10-18T12:43:36.000Z (over 6 years ago)
- Last Synced: 2025-04-29T10:48:50.954Z (about 1 year ago)
- Topics: biojs, blast, blast-output-viewer, bootstrap, html2canvas, javascript, npm
- Language: JavaScript
- Homepage: http://www.sing-group.org/blasterjs/
- Size: 2.26 MB
- Stars: 19
- Watchers: 9
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
biojs-vis-blasterjs
=====
## Authors
* Aitor Blanco Míguez (aiblanco@uvigo.es)
* Dr. Florentino Fernández Riverola (riverola@uvigo.es)
* Dr. Anália Maria Garcia Lourenço (analia@uvigo.es)
* Dr. Borja Sánchez García (borja.sanchez@csic.es)
## Description
[](https://www.npmjs.org/package/biojs-vis-blasterjs)
> A free to use, open source Javascript BLAST alignments viewer library created by SING group.
## How to cite
Blanco-Míguez A, Fdez-Riverola F, SánchezB, Lourenço A (2018) BlasterJS: A novel interactive JavaScript visualisation component for BLAST alignment results. PLoS ONE 13(10): e0205286. https://doi.org/10.1371/journal.pone.0205286
## Requeriments
* Bootstrap 3 ([http://getbootstrap.com/])
* HTML2CANVAS ([http://html2canvas.hertzen.com/])
## Accepted files
BLAST text and XML output files (-outfmt 0 and 5)
> You can check [NCBI BLAST user manual].
## Getting Started
Install the module with: `npm install biojs-vis-blasterjs`
```html
...
...
...
var blasterjs = require("biojs-vis-blasterjs");
var instance = new blasterjs({
input: "blastinput",
multipleAlignments: "blast-multiple-alignments",
alignmentsTable: "blast-alignments-table",
singleAlignment: "blast-single-alignment"
});
```
### Custom options:
Get alignments via String instead of input form:
```html
...
var alignments = "...";
var blasterjs = require("biojs-vis-blasterjs");
var instance = new blasterjs({
string: alignments,
multipleAlignments: "blast-multiple-alignments",
alignmentsTable: "blast-alignments-table",
singleAlignment: "blast-single-alignment",
});
...
```
Define a custom callback on alignment table item click event:
```html
...
var blasterjs = require("biojs-vis-blasterjs");
var instance = new blasterjs({
input: "blastinput",
multipleAlignments: "blast-multiple-alignments",
alignmentsTable: "blast-alignments-table",
singleAlignment: "blast-single-alignment",
callback: function(alignment) { ... }
});
...
```
## Institution
[© SING - Sistemas Informáticos de Nueva Generación 2015]
Department of Computer Science, University of Vigo
ESEI - Escuela Superior de Ingeniería Informática Edificio politécnico
Campus Universitario As Lagoas s/n
32004 Ourense, Spain
Tel: +34 988 387 013
Fax: +34 988 387 001
## Contributing
All contributions are welcome.
## Support
If you have any problem or suggestion please open an issue [here](https://github.com/sing-group/biojs-vis-blasterjs/issues).
## License
[GNU General Public License v3]
BlasterJS is a free to use, open source JS library created by SING Group.
Copyright (C) 2019 SING - Sistemas Informaticos de Nueva Generacion
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
[http://getbootstrap.com/]:
[https://html2canvas.hertzen.com/]:
[© SING - Sistemas Informáticos de Nueva Generación 2019]:
[NCBI BLAST user manual]:
[GNU General Public License v3]: