https://github.com/genentech/uniprot-js
https://github.com/genentech/uniprot-js
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/genentech/uniprot-js
- Owner: Genentech
- License: other
- Created: 2014-02-25T21:16:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-06-01T12:25:26.000Z (about 11 years ago)
- Last Synced: 2024-12-02T16:09:42.415Z (over 1 year ago)
- Language: JavaScript
- Size: 270 KB
- Stars: 7
- Watchers: 19
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# uniprot.js
A (partial) JavaScript Uniprot text file parser
## Description
This library allows the parsing of the unirpot native text format and extract some informations. The "partial" term comes here, where only a few fields, needed for our project are extracted
Each entry comes as a map with sequence, id, accession codes and a selection of features, such as variants, taxonnomy tree, NCBI taxid, corss ref toe PDB structures and so on. The UniprotReaderTest will be the most up to date about which features are parsed.
### Splice variants
Despite other common parsers, the isoforms are a center place. The 'buildIsoformEntries' will provide a list of protein object, one per described isoform.
See the [project homepage](http://github.com/genentech/uniprot.js).
##How to use
Refer to the unit tests to see the library in action.
To build the distribution
npm install
grunt test
grunt build
To publish, git commit and
grunt build
git commit -m 'build'
npm version patch
npm publish
## Installation
Using Bower:
bower install uniprot
Or grab the [source](https://github.com/genentech/uniprot.js/dist/uniprot.js) ([minified](https://github.com/genentech/uniprot.js/dist/uniprot.min.js)).
## Contributing
We'll pull in your contributions if you:
* Provide a comprehensive suite of tests for your fork.
* Have a clear and documented rationale for your changes.
* Package these up in a pull request.
We'll do our best to help you out with any contribution issues you may have.
##Author
(Alexandre Masselot)[masselot.alexandre@gene.com]
## Copyright
2014 Genentech Inc.
## License
BSD. See [LICENSE.txt] in this directory.